From 16e90365f2fcc4efaa3e67e39c15f75c3712ad3d Mon Sep 17 00:00:00 2001 From: xitzhang Date: Mon, 1 Jun 2026 17:45:25 -0700 Subject: [PATCH 01/22] [VoiceLive]Add client name overrides for VoiceLive types and properties for Java (#43358) * Add Java client name overrides for VoiceLive types and properties * Add JS client name overrides for VoiceLive duration/offset properties * Rename Java token usage accessors to counts * Pin Java SDK generation to GA API version * format --------- Co-authored-by: Yulin Li --- .../ai/data-plane/VoiceLive/client.tsp | 95 ++++++++++++++++++- .../ai/data-plane/VoiceLive/tspconfig.yaml | 1 + 2 files changed, 93 insertions(+), 3 deletions(-) diff --git a/specification/ai/data-plane/VoiceLive/client.tsp b/specification/ai/data-plane/VoiceLive/client.tsp index 530157924d72..d5caca14717d 100644 --- a/specification/ai/data-plane/VoiceLive/client.tsp +++ b/specification/ai/data-plane/VoiceLive/client.tsp @@ -738,14 +738,28 @@ using Azure.ClientGenerator.Core; ); @@clientName(VoiceLive.Modality, "InteractionModality", "java"); +@@clientName(VoiceLive.ClientEvent, "SessionClientEvent", "java"); @@clientName(VoiceLive.Animation, "AnimationOptions", "java"); +@@clientName(VoiceLive.Animation.outputs, "outputTypes", "java"); +@@clientName(VoiceLive.LogProbProperties.logprob, "logProb", "java"); +@@clientName( + VoiceLive.ServerEventConversationItemInputAudioTranscriptionCompleted.logprobs, + "logProbs", + "java" +); +@@clientName( + VoiceLive.ServerEventConversationItemInputAudioTranscriptionDelta.logprobs, + "logProbs", + "java" +); +@@clientName(VoiceLive.RequestSession.animation, "animationOptions", "java"); +@@clientName(VoiceLive.ResponseSession.animation, "animationOptions", "java"); @@clientName(VoiceLive.Tool, "VoiceLiveToolInvocation", "java"); @@clientName( VoiceLive.AzureCustomVoice.custom_lexicon_url, "CustomLexiconUri", "java" ); -@@clientName(VoiceLive.IceServer.urls, "Uris", "java"); @@clientName(VoiceLive.VideoCrop.bottom_right, "BottomRightInternal", "java"); @@clientName(VoiceLive.VideoCrop.top_left, "TopLeftInternal", "java"); @@clientName(VoiceLive.Response, "SessionResponse", "java"); @@ -762,7 +776,7 @@ using Azure.ClientGenerator.Core; ); @@clientName(VoiceLive.ResponseStatus, "SessionResponseStatus", "java"); @@clientName(VoiceLive.ResponseItemStatus, "SessionResponseItemStatus", "java"); -@@clientName(VoiceLive.ServerEvent, "SessionUpdate", "java"); +@@clientName(VoiceLive.ServerEvent, "SessionServerEvent", "java"); @@clientName( VoiceLive.ServerEventSessionCreated, "SessionUpdateSessionCreated", @@ -939,10 +953,61 @@ using Azure.ClientGenerator.Core; "SessionUpdateErrorDetails", "java" ); +@@clientName( + VoiceLive.CachedTokenDetails.text_tokens, + "textTokenCount", + "java" +); +@@clientName( + VoiceLive.CachedTokenDetails.audio_tokens, + "audioTokenCount", + "java" +); +@@clientName( + VoiceLive.CachedTokenDetails.image_tokens, + "imageTokenCount", + "java" +); +@@clientName( + VoiceLive.InputTokenDetails.cached_tokens, + "cachedTokenCount", + "java" +); +@@clientName(VoiceLive.InputTokenDetails.text_tokens, "textTokenCount", "java"); +@@clientName( + VoiceLive.InputTokenDetails.audio_tokens, + "audioTokenCount", + "java" +); +@@clientName( + VoiceLive.InputTokenDetails.image_tokens, + "imageTokenCount", + "java" +); +@@clientName( + VoiceLive.OutputTokenDetails.text_tokens, + "textTokenCount", + "java" +); +@@clientName( + VoiceLive.OutputTokenDetails.audio_tokens, + "audioTokenCount", + "java" +); +@@clientName( + VoiceLive.OutputTokenDetails.reasoning_tokens, + "reasoningTokenCount", + "java" +); +@@clientName(VoiceLive.TokenUsage.total_tokens, "totalTokenCount", "java"); +@@clientName(VoiceLive.TokenUsage.input_tokens, "inputTokenCount", "java"); +@@clientName(VoiceLive.TokenUsage.output_tokens, "outputTokenCount", "java"); @@clientName(VoiceLive.TokenUsage, "ResponseTokenStatistics", "java"); @@clientName(VoiceLive.RequestSession, "VoiceLiveSessionOptions", "java"); @@clientName(VoiceLive.ResponseSession, "VoiceLiveSessionResponse", "java"); -@@clientName(VoiceLive.AvatarConfig, "AvatarConfiguration", "java"); +@@clientName(VoiceLive.AvatarConfig, "AvatarOptions", "java"); +@@clientName(VoiceLive.RequestSession.avatar, "avatarOptions", "java"); +@@clientName(VoiceLive.ResponseSession.avatar, "avatarOptions", "java"); @@clientName(VoiceLive.AzureSemanticDetection.timeout_ms, "TimeoutMs", "java"); @@clientName( VoiceLive.AzureSemanticDetectionEn.timeout_ms, @@ -986,6 +1051,30 @@ using Azure.ClientGenerator.Core; "java" ); @@clientName(VoiceLive.Background, "VideoBackground", "java"); +@@clientName(VoiceLive.MCPTool, "McpTool", "java"); +@@clientName(VoiceLive.MCPServer, "McpServer", "java"); +@@clientName(VoiceLive.MCPApprovalType, "McpApprovalType", "java"); +@@clientName( + VoiceLive.MCPApprovalResponseRequestItem, + "McpApprovalResponseRequestItem", + "java" +); +@@clientName( + VoiceLive.ResponseMCPListToolItem, + "ResponseMcpListToolItem", + "java" +); +@@clientName(VoiceLive.ResponseMCPCallItem, "ResponseMcpCallItem", "java"); +@@clientName( + VoiceLive.ResponseMCPApprovalRequestItem, + "ResponseMcpApprovalRequestItem", + "java" +); +@@clientName( + VoiceLive.ResponseMCPApprovalResponseItem, + "ResponseMcpApprovalResponseItem", + "java" +); @@clientName( VoiceLive.AzureSemanticDetection.timeout_ms, diff --git a/specification/ai/data-plane/VoiceLive/tspconfig.yaml b/specification/ai/data-plane/VoiceLive/tspconfig.yaml index 76338e580c56..45b67dfd9387 100644 --- a/specification/ai/data-plane/VoiceLive/tspconfig.yaml +++ b/specification/ai/data-plane/VoiceLive/tspconfig.yaml @@ -44,6 +44,7 @@ options: generate-test: false src-folder: "generated" "@azure-tools/typespec-java": + api-version: "2026-04-10" emitter-output-dir: "{output-dir}/{service-dir}/azure-ai-voicelive" namespace: com.azure.ai.voicelive use-eclipse-language-server: false From 924420fe602b631163f1e2628337c2dd7f26c173 Mon Sep 17 00:00:00 2001 From: emilyjiji <92887308+emilyjiji@users.noreply.github.com> Date: Mon, 1 Jun 2026 19:23:22 -0700 Subject: [PATCH 02/22] Ejiji/voicelive main api version pin (#43668) * Pin VoiceLive C#, HTTP C#, and Java emitters to 2026-04-10 * name changes * Update tspconfig.yaml * test removal of child id * update schemas * add customization to sdk --------- Co-authored-by: Emily Jiji --- specification/ai/data-plane/VoiceLive/client.tsp | 1 + specification/ai/data-plane/VoiceLive/items.tsp | 6 ------ .../VoiceLive/preview/2026-06-01-preview/VoiceLive.json | 8 -------- .../data-plane/VoiceLive/stable/2026-04-10/VoiceLive.json | 8 -------- specification/ai/data-plane/VoiceLive/tspconfig.yaml | 2 ++ 5 files changed, 3 insertions(+), 22 deletions(-) diff --git a/specification/ai/data-plane/VoiceLive/client.tsp b/specification/ai/data-plane/VoiceLive/client.tsp index d5caca14717d..7c89e7c79259 100644 --- a/specification/ai/data-plane/VoiceLive/client.tsp +++ b/specification/ai/data-plane/VoiceLive/client.tsp @@ -484,6 +484,7 @@ using Azure.ClientGenerator.Core; ); @@clientName(VoiceLive.MCPApprovalType, "McpApprovalKind", "csharp"); @@clientName(VoiceLive.ReasoningEffort.xhigh, "ExtraHigh", "csharp"); +@@clientName(VoiceLive.AvatarConfigTypes, "AvatarConfigKind", "csharp"); @@clientName( VoiceLive.PersonalVoiceModels.`MAI-Voice-1`, "MaiVoice1", diff --git a/specification/ai/data-plane/VoiceLive/items.tsp b/specification/ai/data-plane/VoiceLive/items.tsp index 096329654aa2..fd18f70ec616 100644 --- a/specification/ai/data-plane/VoiceLive/items.tsp +++ b/specification/ai/data-plane/VoiceLive/items.tsp @@ -530,9 +530,6 @@ model ResponseWebSearchCallItem extends ResponseItem { /** The type of the item. Always 'web_search_call'. */ type: ItemType.web_search_call; - /** The unique ID of the web search tool call. */ - id?: string; - /** The status of the web search tool call. */ #suppress "@azure-tools/typespec-azure-core/no-unnamed-union" "Keeping inline union to match source." status: "in_progress" | "searching" | "completed" | "failed" | string; @@ -567,9 +564,6 @@ model ResponseFileSearchCallItem extends ResponseItem { /** The type of the item. Always 'file_search_call'. */ type: ItemType.file_search_call; - /** The unique ID of the file search tool call. */ - id?: string; - /** The queries used for the file search. */ queries?: string[]; diff --git a/specification/ai/data-plane/VoiceLive/preview/2026-06-01-preview/VoiceLive.json b/specification/ai/data-plane/VoiceLive/preview/2026-06-01-preview/VoiceLive.json index 9639993f3de3..f8f29054f4c4 100644 --- a/specification/ai/data-plane/VoiceLive/preview/2026-06-01-preview/VoiceLive.json +++ b/specification/ai/data-plane/VoiceLive/preview/2026-06-01-preview/VoiceLive.json @@ -3425,10 +3425,6 @@ "type": "object", "description": "A response item that represents a file search call.", "properties": { - "id": { - "type": "string", - "description": "The unique ID of the file search tool call." - }, "queries": { "type": "array", "description": "The queries used for the file search.", @@ -4011,10 +4007,6 @@ "type": "object", "description": "A response item that represents a web search call.", "properties": { - "id": { - "type": "string", - "description": "The unique ID of the web search tool call." - }, "status": { "type": "string", "description": "The status of the web search tool call.", diff --git a/specification/ai/data-plane/VoiceLive/stable/2026-04-10/VoiceLive.json b/specification/ai/data-plane/VoiceLive/stable/2026-04-10/VoiceLive.json index 0a7234e457e1..284f41adce26 100644 --- a/specification/ai/data-plane/VoiceLive/stable/2026-04-10/VoiceLive.json +++ b/specification/ai/data-plane/VoiceLive/stable/2026-04-10/VoiceLive.json @@ -3153,10 +3153,6 @@ "type": "object", "description": "A response item that represents a file search call.", "properties": { - "id": { - "type": "string", - "description": "The unique ID of the file search tool call." - }, "queries": { "type": "array", "description": "The queries used for the file search.", @@ -3734,10 +3730,6 @@ "type": "object", "description": "A response item that represents a web search call.", "properties": { - "id": { - "type": "string", - "description": "The unique ID of the web search tool call." - }, "status": { "type": "string", "description": "The status of the web search tool call.", diff --git a/specification/ai/data-plane/VoiceLive/tspconfig.yaml b/specification/ai/data-plane/VoiceLive/tspconfig.yaml index 45b67dfd9387..32d54b55d93c 100644 --- a/specification/ai/data-plane/VoiceLive/tspconfig.yaml +++ b/specification/ai/data-plane/VoiceLive/tspconfig.yaml @@ -25,12 +25,14 @@ options: emitter-output-dir: "{output-dir}/{service-dir}/azure-ai-voicelive" "@azure-tools/typespec-csharp": emitter-output-dir: "{output-dir}/{service-dir}/Azure.AI.VoiceLive" + api-version: "2026-04-10" clear-output-folder: true model-namespace: false namespace: "Azure.AI.VoiceLive" flavor: azure "@azure-typespec/http-client-csharp": namespace: Azure.AI.VoiceLive + api-version: "2026-04-10" model-namespace: false emitter-output-dir: "{output-dir}/{service-dir}/{namespace}" "@azure-tools/typespec-ts": From d9c59b511bcc6c7df5be44a2284f4bf342147615 Mon Sep 17 00:00:00 2001 From: xitzhang Date: Mon, 1 Jun 2026 22:55:24 -0700 Subject: [PATCH 03/22] Remove Java api-version from tspconfig.yaml (#43677) --- specification/ai/data-plane/VoiceLive/tspconfig.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/ai/data-plane/VoiceLive/tspconfig.yaml b/specification/ai/data-plane/VoiceLive/tspconfig.yaml index 32d54b55d93c..608b43e23bcc 100644 --- a/specification/ai/data-plane/VoiceLive/tspconfig.yaml +++ b/specification/ai/data-plane/VoiceLive/tspconfig.yaml @@ -46,7 +46,6 @@ options: generate-test: false src-folder: "generated" "@azure-tools/typespec-java": - api-version: "2026-04-10" emitter-output-dir: "{output-dir}/{service-dir}/azure-ai-voicelive" namespace: com.azure.ai.voicelive use-eclipse-language-server: false From d6072e52d30ad48257785d5917226a16445d812e Mon Sep 17 00:00:00 2001 From: "Jiao Di (MSFT)" <80496810+v-jiaodi@users.noreply.github.com> Date: Tue, 2 Jun 2026 14:05:02 +0800 Subject: [PATCH 04/22] [JS] Update config to mitigate sdk breaking change (#43675) * update config * update config * update config * Fix emitter-output-dir formatting in tspconfig.yaml * Update tspconfig.yaml * Fix formatting in tspconfig.yaml * update --- .../redis/resource-manager/Microsoft.Cache/Redis/client.tsp | 2 +- .../redis/resource-manager/Microsoft.Cache/Redis/tspconfig.yaml | 1 + .../relay/resource-manager/Microsoft.Relay/Relay/tspconfig.yaml | 1 + .../resource-manager/Microsoft.Support/Support/tspconfig.yaml | 1 + 4 files changed, 4 insertions(+), 1 deletion(-) diff --git a/specification/redis/resource-manager/Microsoft.Cache/Redis/client.tsp b/specification/redis/resource-manager/Microsoft.Cache/Redis/client.tsp index e9871895fd1a..2e7a7c1405e5 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/Redis/client.tsp +++ b/specification/redis/resource-manager/Microsoft.Cache/Redis/client.tsp @@ -66,7 +66,7 @@ model RedisCommonPropertiesRedisConfigurationRecordString { #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Back compatibility" @@Azure.ClientGenerator.Core.Legacy.flattenProperty( Azure.ResourceManager.CommonTypes.PrivateLinkResource.properties, - "java" + "java,javascript" ); #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Back compatibility for C# SDK" #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Back compatibility for C# SDK" diff --git a/specification/redis/resource-manager/Microsoft.Cache/Redis/tspconfig.yaml b/specification/redis/resource-manager/Microsoft.Cache/Redis/tspconfig.yaml index 7acdef6e9046..0600242ea36f 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/Redis/tspconfig.yaml +++ b/specification/redis/resource-manager/Microsoft.Cache/Redis/tspconfig.yaml @@ -38,6 +38,7 @@ options: "@azure-tools/typespec-ts": emitter-output-dir: "{output-dir}/{service-dir}/arm-rediscache" flavor: azure + compatibility-lro: true experimental-extensible-enums: true package-details: name: "@azure/arm-rediscache" diff --git a/specification/relay/resource-manager/Microsoft.Relay/Relay/tspconfig.yaml b/specification/relay/resource-manager/Microsoft.Relay/Relay/tspconfig.yaml index 6cea90b3d872..86718d0fe335 100644 --- a/specification/relay/resource-manager/Microsoft.Relay/Relay/tspconfig.yaml +++ b/specification/relay/resource-manager/Microsoft.Relay/Relay/tspconfig.yaml @@ -31,6 +31,7 @@ options: "@azure-tools/typespec-ts": emitter-output-dir: "{output-dir}/{service-dir}/arm-relay" flavor: "azure" + compatibility-lro: true experimental-extensible-enums: true typespec-title-map: RelayClient: "RelayAPI" diff --git a/specification/support/resource-manager/Microsoft.Support/Support/tspconfig.yaml b/specification/support/resource-manager/Microsoft.Support/Support/tspconfig.yaml index 1dc0a17d1e6a..2a2b4090a31c 100644 --- a/specification/support/resource-manager/Microsoft.Support/Support/tspconfig.yaml +++ b/specification/support/resource-manager/Microsoft.Support/Support/tspconfig.yaml @@ -30,6 +30,7 @@ options: package-details: name: "@azure/arm-support" flavor: azure + compatibility-lro: true experimental-extensible-enums: true "@azure-tools/typespec-java": emitter-output-dir: "{output-dir}/{service-dir}/azure-resourcemanager-support" From 465402d314b9a9ce96f122c5b10fdf416e7ef727 Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Tue, 2 Jun 2026 15:06:39 +0800 Subject: [PATCH 05/22] [sql] Update client.tsp (#43573) * Update client.tsp * Update client.tsp --- .../Microsoft.Sql/SQL/client.tsp | 81 +++---------------- 1 file changed, 9 insertions(+), 72 deletions(-) diff --git a/specification/sql/resource-manager/Microsoft.Sql/SQL/client.tsp b/specification/sql/resource-manager/Microsoft.Sql/SQL/client.tsp index 76d5a91dcb65..b3ace7fec974 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/SQL/client.tsp +++ b/specification/sql/resource-manager/Microsoft.Sql/SQL/client.tsp @@ -89,18 +89,22 @@ using Microsoft.Sql; @@clientName(AvailabilityZoneType.`2`, "TWO", "python"); @@clientName(AvailabilityZoneType.`3`, "THREE", "python"); -@@alternateType(BlobAuditingPolicyName, "default", "go,javascript"); -@@alternateType(DataMaskingPolicyName, "Default", "javascript"); -@@alternateType(CurrentSensitivityLabelSource, "current", "go,javascript"); +@@alternateType(BlobAuditingPolicyName, "default", "go,javascript,python"); +@@alternateType(DataMaskingPolicyName, "Default", "javascript,python"); +@@alternateType( + CurrentSensitivityLabelSource, + "current", + "go,javascript,python" +); @@alternateType( RecommendedSensitivityLabelSource, "recommended", - "go,javascript" + "go,javascript,python" ); @@alternateType( VulnerabilityAssessmentSystemDatabaseName, "master", - "go,javascript" + "go,javascript,python" ); @@alternateType( CheckNameAvailabilityResourceType, @@ -112,70 +116,3 @@ using Microsoft.Sql; "VulnerabilityAssessmentScanRecordForSQLListResult ", "go" ); - -#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "To mitigate breaking change for legacy Python SDK" -@@Legacy.clientDefaultValue( - SensitivityLabelSourceAlias.sensitivityLabelSource, - "current", - "python" -); -@@alternateType( - SensitivityLabelSourceAlias.sensitivityLabelSource, - "current", - "python" -); -#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "To mitigate breaking change for legacy Python SDK" -@@Legacy.clientDefaultValue( - RecommendedSensitivityLabelSourceAlias.sensitivityLabelSource, - "recommended", - "python" -); -@@alternateType( - RecommendedSensitivityLabelSourceAlias.sensitivityLabelSource, - "recommended", - "python" -); -#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "To mitigate breaking change for legacy Python SDK" -@@Legacy.clientDefaultValue( - ServerBlobAuditingPolicyNameAlias.blobAuditingPolicyName, - "default", - "python" -); -@@alternateType( - ServerBlobAuditingPolicyNameAlias.blobAuditingPolicyName, - "default", - "python" -); -#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "To mitigate breaking change for legacy Python SDK" -@@Legacy.clientDefaultValue( - DatabaseBlobAuditingPolicyNameAlias.blobAuditingPolicyName, - "default", - "python" -); -@@alternateType( - DatabaseBlobAuditingPolicyNameAlias.blobAuditingPolicyName, - "default", - "python" -); -#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "To mitigate breaking change for legacy Python SDK" -@@Legacy.clientDefaultValue( - ExtendedDatabaseBlobAuditingPolicyNameAlias.blobAuditingPolicyName, - "default", - "python" -); -@@alternateType( - ExtendedDatabaseBlobAuditingPolicyNameAlias.blobAuditingPolicyName, - "default", - "python" -); -#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "To mitigate breaking change for legacy Python SDK" -@@Legacy.clientDefaultValue( - ExtendedServerBlobAuditingPolicyNameAlias.blobAuditingPolicyName, - "default", - "python" -); -@@alternateType( - ExtendedServerBlobAuditingPolicyNameAlias.blobAuditingPolicyName, - "default", - "python" -); From a427dd4d108b1fb93340dfeca3994de1c695b53b Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Tue, 2 Jun 2026 16:59:25 +0800 Subject: [PATCH 06/22] Mitigate Python SDK breaking changes for azure-mgmt-devhub (#43681) --- .../resource-manager/Microsoft.DevHub/DeveloperHub/client.tsp | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/DeveloperHub/client.tsp b/specification/developerhub/resource-manager/Microsoft.DevHub/DeveloperHub/client.tsp index ef4aa058b259..b0b740a3f98b 100644 --- a/specification/developerhub/resource-manager/Microsoft.DevHub/DeveloperHub/client.tsp +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/DeveloperHub/client.tsp @@ -10,6 +10,7 @@ using Microsoft.DevHub; @@clientName(WorkflowRun.workflowRunURL, "workflowRunUrl", "java"); @@clientName(PullRequest.prURL, "prUrl", "java"); @@clientName(Microsoft.DevHub, "DeveloperHubServiceClient", "javascript,java"); +@@clientName(Microsoft.DevHub, "DevHubMgmtClient", "python"); @@clientName(ACR, "Acr", "java,javascript"); @@clientName(Deployment, "DeploymentProperties", "java,javascript"); // consistency on "AdoOAuth" From 21ccd4d484b76e1205207979b84d8d9b4b47fef5 Mon Sep 17 00:00:00 2001 From: Nacho Alonso Portillo <41644064+nachoalonsoportillo@users.noreply.github.com> Date: Tue, 2 Jun 2026 16:49:15 +0200 Subject: [PATCH 07/22] [HorizonDB] Change namespace casing in examples (#43640) * Change namespace casing and location in examples * Update namespace casing for HorizonDb examples * Revert location * Remove sourceClusterResourceId from Clusters_CreateOrUpdate example * Update fully qualified domain names in HorizonDB examples * Update zonePlacementPolicy to BestEffort in HorizonDB examples * Fix resource provider naming inconsistencies in HorizonDb examples - Updated resource provider names from "Microsoft.HorizonDB" to "Microsoft.HorizonDb" in various example JSON files for consistency. - Modified resource IDs in examples for Clusters, FirewallRules, ParameterGroups, Pools, PrivateEndpointConnections, and Replicas to reflect the correct casing. - Ensured that all example responses and requests align with the updated naming conventions. * Fix casing inconsistencies for HorizonDB in API documentation and models * Fix resource type casing in HorizonDb examples to use consistent casing for Microsoft.HorizonDb --- .../Clusters_CreateOrUpdate.json | 15 +- .../2026-01-20-preview/Clusters_Delete.json | 2 +- .../2026-01-20-preview/Clusters_Get.json | 8 +- .../Clusters_ListByResourceGroup.json | 8 +- .../Clusters_ListBySubscription.json | 8 +- .../2026-01-20-preview/Clusters_Update.json | 6 +- .../FirewallRules_CreateOrUpdate.json | 2 +- .../FirewallRules_Delete.json | 2 +- .../2026-01-20-preview/FirewallRules_Get.json | 2 +- .../FirewallRules_List.json | 2 +- .../2026-01-20-preview/Operations_List.json | 281 ++++++++++++++++-- .../ParameterGroups_CreateOrUpdate.json | 2 +- .../ParameterGroups_Delete.json | 2 +- .../ParameterGroups_Get.json | 2 +- .../ParameterGroups_ListByResourceGroup.json | 2 +- .../ParameterGroups_ListBySubscription.json | 4 +- .../ParameterGroups_ListConnections.json | 2 +- .../ParameterGroups_Update.json | 2 +- .../2026-01-20-preview/Pools_Get.json | 2 +- .../2026-01-20-preview/Pools_List.json | 2 +- .../PrivateLinkResources_Get.json | 2 +- .../PrivateLinkResources_List.json | 2 +- .../Replicas_CreateOrUpdate.json | 2 +- .../2026-01-20-preview/Replicas_Delete.json | 2 +- .../2026-01-20-preview/Replicas_Get.json | 2 +- .../2026-01-20-preview/Replicas_List.json | 2 +- .../2026-01-20-preview/Replicas_Update.json | 2 +- .../Microsoft.HorizonDb/HorizonDb/main.tsp | 4 +- .../Microsoft.HorizonDb/HorizonDb/models.tsp | 74 ++--- .../examples/Clusters_CreateOrUpdate.json | 15 +- .../examples/Clusters_Delete.json | 2 +- .../examples/Clusters_Get.json | 8 +- .../Clusters_ListByResourceGroup.json | 8 +- .../examples/Clusters_ListBySubscription.json | 8 +- .../examples/Clusters_Update.json | 6 +- .../FirewallRules_CreateOrUpdate.json | 2 +- .../examples/FirewallRules_Delete.json | 2 +- .../examples/FirewallRules_Get.json | 2 +- .../examples/FirewallRules_List.json | 2 +- .../examples/Operations_List.json | 281 ++++++++++++++++-- .../ParameterGroups_CreateOrUpdate.json | 2 +- .../examples/ParameterGroups_Delete.json | 2 +- .../examples/ParameterGroups_Get.json | 2 +- .../ParameterGroups_ListByResourceGroup.json | 2 +- .../ParameterGroups_ListBySubscription.json | 4 +- .../ParameterGroups_ListConnections.json | 2 +- .../examples/ParameterGroups_Update.json | 2 +- .../examples/Pools_Get.json | 2 +- .../examples/Pools_List.json | 2 +- .../examples/PrivateLinkResources_Get.json | 2 +- .../examples/PrivateLinkResources_List.json | 2 +- .../examples/Replicas_CreateOrUpdate.json | 2 +- .../examples/Replicas_Delete.json | 2 +- .../examples/Replicas_Get.json | 2 +- .../examples/Replicas_List.json | 2 +- .../examples/Replicas_Update.json | 2 +- .../preview/2026-01-20-preview/openapi.json | 256 ++++++++-------- .../Microsoft.HorizonDb/HorizonDb/routes.tsp | 50 ++-- .../horizondb/resource-manager/readme.md | 2 +- 59 files changed, 799 insertions(+), 327 deletions(-) diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_CreateOrUpdate.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_CreateOrUpdate.json index a7b0fe93e5c8..e80ed8fb06dc 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_CreateOrUpdate.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_CreateOrUpdate.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbClusters_CreateOrUpdate", - "title": "Create or update a HorizonDb cluster", + "title": "Create or update a HorizonDB cluster", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", @@ -13,13 +13,12 @@ }, "properties": { "createMode": "Create", - "sourceClusterResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/examplesourceresourcegroup/providers/Microsoft.HorizonDb/clusters/examplesourcecluster", "version": "17", "administratorLogin": "exampleadministratorlogin", "administratorLoginPassword": "examplepassword", "vCores": 4, "replicaCount": 2, - "zonePlacementPolicy": "Strict" + "zonePlacementPolicy": "BestEffort" } } }, @@ -37,13 +36,12 @@ "administratorLogin": "exampleadministratorlogin", "version": "17", "createMode": "Create", - "sourceClusterResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/examplesourceresourcegroup/providers/Microsoft.HorizonDb/clusters/examplesourcecluster", "vCores": 4, "replicaCount": 2, - "zonePlacementPolicy": "Strict", + "zonePlacementPolicy": "BestEffort", "state": "Ready", - "fullyQualifiedDomainName": "examplecluster.westus2.horizondb.azure.com", - "readonlyEndpoint": "examplecluster-ro.horizondb.azure.com", + "fullyQualifiedDomainName": "examplecluster.ffffffffffff.westus2.horizondb.azure.com", + "readonlyEndpoint": "examplecluster.ffffffffffff-ro.horizondb.azure.com", "provisioningState": "Succeeded" } } @@ -61,10 +59,9 @@ "administratorLogin": "exampleadministratorlogin", "version": "17", "createMode": "Create", - "sourceClusterResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/examplesourceresourcegroup/providers/Microsoft.HorizonDb/clusters/examplesourcecluster", "vCores": 4, "replicaCount": 2, - "zonePlacementPolicy": "Strict", + "zonePlacementPolicy": "BestEffort", "provisioningState": "Provisioning" } } diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_Delete.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_Delete.json index edb111450fff..6c770b7c026a 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_Delete.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_Delete.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbClusters_Delete", - "title": "Delete a HorizonDb cluster", + "title": "Delete a HorizonDB cluster", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_Get.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_Get.json index b189c0218c33..21b28cc9f4c4 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_Get.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_Get.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbClusters_Get", - "title": "Get a HorizonDb cluster", + "title": "Get a HorizonDB cluster", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", @@ -22,10 +22,10 @@ "version": "17", "vCores": 4, "replicaCount": 2, - "zonePlacementPolicy": "Strict", + "zonePlacementPolicy": "BestEffort", "state": "Ready", - "fullyQualifiedDomainName": "examplecluster.westus2.horizondb.azure.com", - "readonlyEndpoint": "examplecluster-ro.horizondb.azure.com", + "fullyQualifiedDomainName": "examplecluster.ffffffffffff.westus2.horizondb.azure.com", + "readonlyEndpoint": "examplecluster.ffffffffffff-ro.horizondb.azure.com", "provisioningState": "Succeeded" } } diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_ListByResourceGroup.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_ListByResourceGroup.json index 9bdf12046646..d6b488341303 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_ListByResourceGroup.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_ListByResourceGroup.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbClusters_ListByResourceGroup", - "title": "List HorizonDb clusters in a resource group", + "title": "List HorizonDB clusters in a resource group", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", @@ -23,9 +23,9 @@ "version": "17", "vCores": 4, "replicaCount": 2, - "zonePlacementPolicy": "Strict", + "zonePlacementPolicy": "BestEffort", "state": "Ready", - "fullyQualifiedDomainName": "examplecluster.westus2.horizondb.azure.com", + "fullyQualifiedDomainName": "examplecluster.ffffffffffff.westus2.horizondb.azure.com", "readonlyEndpoint": "examplecluster-ro.westus2.horizondb.azure.com", "provisioningState": "Succeeded" } @@ -43,7 +43,7 @@ "version": "17", "vCores": 2, "replicaCount": 1, - "zonePlacementPolicy": "Strict", + "zonePlacementPolicy": "BestEffort", "state": "Ready", "fullyQualifiedDomainName": "examplecluster2.westus2.horizondb.azure.com", "readonlyEndpoint": "examplecluster2-ro.westus2.horizondb.azure.com", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_ListBySubscription.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_ListBySubscription.json index c5d2ab4ff2c1..312f5793b9e8 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_ListBySubscription.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_ListBySubscription.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbClusters_ListBySubscription", - "title": "List HorizonDb clusters by subscription", + "title": "List HorizonDB clusters by subscription", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "api-version": "2026-01-20-preview" @@ -22,9 +22,9 @@ "version": "17", "vCores": 4, "replicaCount": 2, - "zonePlacementPolicy": "Strict", + "zonePlacementPolicy": "BestEffort", "state": "Ready", - "fullyQualifiedDomainName": "examplecluster.westus2.horizondb.azure.com", + "fullyQualifiedDomainName": "examplecluster.ffffffffffff.westus2.horizondb.azure.com", "readonlyEndpoint": "examplecluster-ro.westus2.horizondb.azure.com", "provisioningState": "Succeeded" } @@ -42,7 +42,7 @@ "version": "17", "vCores": 2, "replicaCount": 1, - "zonePlacementPolicy": "Strict", + "zonePlacementPolicy": "BestEffort", "state": "Ready", "fullyQualifiedDomainName": "examplecluster2.westus2.horizondb.azure.com", "readonlyEndpoint": "examplecluster2-ro.westus2.horizondb.azure.com", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_Update.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_Update.json index 920dc54a9ae0..5f97235385e6 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_Update.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Clusters_Update.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbClusters_Update", - "title": "Update a HorizonDb cluster", + "title": "Update a HorizonDB cluster", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", @@ -33,9 +33,9 @@ "createMode": "Update", "vCores": 8, "replicaCount": 2, - "zonePlacementPolicy": "Strict", + "zonePlacementPolicy": "BestEffort", "state": "Ready", - "fullyQualifiedDomainName": "examplecluster.westus2.horizondb.azure.com", + "fullyQualifiedDomainName": "examplecluster.ffffffffffff.westus2.horizondb.azure.com", "readonlyEndpoint": "examplecluster-ro.westus2.horizondb.azure.com", "provisioningState": "Succeeded" } diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/FirewallRules_CreateOrUpdate.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/FirewallRules_CreateOrUpdate.json index 6c7f6c519745..95d8e5ea4d2a 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/FirewallRules_CreateOrUpdate.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/FirewallRules_CreateOrUpdate.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbFirewallRules_CreateOrUpdate", - "title": "Create or update a HorizonDb firewall rule", + "title": "Create or update a HorizonDB firewall rule", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/FirewallRules_Delete.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/FirewallRules_Delete.json index 91746b5fa2bc..872db101ebe2 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/FirewallRules_Delete.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/FirewallRules_Delete.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbFirewallRules_Delete", - "title": "Delete a HorizonDb firewall rule", + "title": "Delete a HorizonDB firewall rule", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/FirewallRules_Get.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/FirewallRules_Get.json index 51fd72fb0197..52c4cf8bd7dd 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/FirewallRules_Get.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/FirewallRules_Get.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbFirewallRules_Get", - "title": "Get a HorizonDb firewall rule", + "title": "Get a HorizonDB firewall rule", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/FirewallRules_List.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/FirewallRules_List.json index 3375924f05e4..0c827fbc4184 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/FirewallRules_List.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/FirewallRules_List.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbFirewallRules_List", - "title": "List HorizonDb firewall rules in a pool", + "title": "List HorizonDB firewall rules in a pool", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Operations_List.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Operations_List.json index 107105b97d2b..6a1b50064a3d 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Operations_List.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Operations_List.json @@ -1,6 +1,6 @@ { "operationId": "Operations_List", - "title": "List operations for Microsoft.HorizonDb", + "title": "List operations for Microsoft.HorizonDB", "parameters": { "api-version": "2026-01-20-preview" }, @@ -9,37 +9,276 @@ "body": { "value": [ { - "name": "Microsoft.HorizonDb/clusters/read", - "isDataAction": false, + "name": "Microsoft.HorizonDb/clusters/write", "display": { - "provider": "Microsoft HorizonDb", - "resource": "HorizonDb Clusters", - "operation": "Get/List HorizonDb clusters", - "description": "Retrieves the properties of the specified HorizonDb clusters." - }, - "origin": "user,system" + "resource": "HorizonDb Cluster", + "operation": "Create/Update HorizonDb cluster", + "description": "Creates a HorizonDb cluster with the specified parameters or update the properties or tags for the specified cluster." + } }, { "name": "Microsoft.HorizonDb/clusters/write", - "isDataAction": false, "display": { - "provider": "Microsoft HorizonDb", - "resource": "HorizonDb Clusters", + "resource": "HorizonDb Cluster", "operation": "Create/Update HorizonDb cluster", - "description": "Creates a new HorizonDb cluster or updates an existing one." - }, - "origin": "user,system" + "description": "Creates a HorizonDb cluster with the specified parameters or update the properties or tags for the specified cluster." + } }, { "name": "Microsoft.HorizonDb/clusters/delete", - "isDataAction": false, "display": { - "provider": "Microsoft HorizonDb", - "resource": "HorizonDb Clusters", + "resource": "HorizonDb Cluster", "operation": "Delete HorizonDb cluster", - "description": "Deletes a HorizonDb cluster." - }, - "origin": "user,system" + "description": "Deletes an existing HorizonDb cluster." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/read", + "display": { + "resource": "HorizonDb Cluster", + "operation": "List/Get HorizonDb cluster", + "description": "Return the list of HorizonDb clusters or gets the properties for the specified cluster." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/read", + "display": { + "resource": "HorizonDb Cluster", + "operation": "List HorizonDb clusters in subscription", + "description": "Lists all HorizonDb clusters in the subscription." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/pools/replicas/write", + "display": { + "resource": "HorizonDb Replica", + "operation": "Create/Update HorizonDb replica", + "description": "Creates or updates a HorizonDb replica with the specified parameters." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/pools/replicas/read", + "display": { + "resource": "HorizonDb Replica", + "operation": "Get HorizonDb replica", + "description": "Gets the properties for the specified HorizonDb replica." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/pools/replicas/delete", + "display": { + "resource": "HorizonDb Replica", + "operation": "Delete HorizonDb replica", + "description": "Deletes an existing HorizonDb replica." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/pools/replicas/write", + "display": { + "resource": "HorizonDb Replica", + "operation": "Create/Update HorizonDb replica", + "description": "Creates or updates a HorizonDb replica with the specified parameters." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/effectiveParameters/read", + "display": { + "resource": "HorizonDb Cluster Effective Parameters", + "operation": "Get HorizonDb cluster effective parameters", + "description": "Gets the effective (parameter group merged with per-cluster overrides) parameter set for a HorizonDb cluster." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/read", + "display": { + "resource": "HorizonDb Cluster", + "operation": "List HorizonDb clusters in subscription", + "description": "Lists all HorizonDb clusters in the subscription." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/pools/firewallRules/write", + "display": { + "resource": "HorizonDb Firewall Rule", + "operation": "Create/Update HorizonDb firewall rule", + "description": "Creates or updates a HorizonDb firewall rule with the specified parameters." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/pools/firewallRules/delete", + "display": { + "resource": "HorizonDb Firewall Rule", + "operation": "Delete HorizonDb firewall rule", + "description": "Deletes an existing HorizonDb firewall rule." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/pools/firewallRules/read", + "display": { + "resource": "HorizonDb Firewall Rule", + "operation": "List HorizonDb firewall rules", + "description": "Lists all firewall rules for the specified HorizonDb pool." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/pools/firewallRules/read", + "display": { + "resource": "HorizonDb Firewall Rule", + "operation": "Get HorizonDb firewall rule", + "description": "Gets the properties for the specified HorizonDb firewall rule." + } + }, + { + "name": "Microsoft.HorizonDb/parameterGroups/write", + "display": { + "resource": "HorizonDb Parameter Group", + "operation": "Create/Update HorizonDb parameter group", + "description": "Creates or updates a HorizonDb parameter group with the specified parameters." + } + }, + { + "name": "Microsoft.HorizonDb/parameterGroups/write", + "display": { + "resource": "HorizonDb Parameter Group", + "operation": "Create/Update HorizonDb parameter group", + "description": "Creates or updates a HorizonDb parameter group with the specified parameters." + } + }, + { + "name": "Microsoft.HorizonDb/parameterGroups/delete", + "display": { + "resource": "HorizonDb Parameter Group", + "operation": "Delete HorizonDb parameter group", + "description": "Deletes an existing HorizonDb parameter group." + } + }, + { + "name": "Microsoft.HorizonDb/parameterGroups/read", + "display": { + "resource": "HorizonDb Parameter Group", + "operation": "Get HorizonDb parameter group", + "description": "Gets the properties for the specified HorizonDb parameter group." + } + }, + { + "name": "Microsoft.HorizonDb/parameterGroups/connections/read", + "display": { + "resource": "HorizonDb Parameter Group", + "operation": "Get HorizonDb parameter group connections", + "description": "Gets the clusters connected to a HorizonDb parameter group." + } + }, + { + "name": "Microsoft.HorizonDb/parameterGroups/read", + "display": { + "resource": "HorizonDb Parameter Group", + "operation": "List HorizonDb parameter groups in subscription", + "description": "Lists all HorizonDb parameter groups in the subscription." + } + }, + { + "name": "Microsoft.HorizonDb/parameterGroups/versions/read", + "display": { + "resource": "HorizonDb Parameter Group", + "operation": "Get HorizonDb parameter group versions", + "description": "Gets the versions of a HorizonDb parameter group." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/pools/write", + "display": { + "resource": "HorizonDb Pool", + "operation": "Create/Update HorizonDb pool", + "description": "Creates or updates a HorizonDb pool with the specified parameters." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/pools/delete", + "display": { + "resource": "HorizonDb Pool", + "operation": "Delete HorizonDb pool", + "description": "Deletes an existing HorizonDb pool." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/pools/write", + "display": { + "resource": "HorizonDb Pool", + "operation": "Create/Update HorizonDb pool", + "description": "Creates or updates a HorizonDb pool with the specified parameters." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/privateEndpointConnectionProxies/write", + "display": { + "resource": "HorizonDb Private Endpoint Connection Proxy", + "operation": "Create/Update HorizonDb private endpoint connection proxy", + "description": "Creates or updates a HorizonDb private endpoint connection proxy." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/privateEndpointConnectionProxies/read", + "display": { + "resource": "HorizonDb Private Endpoint Connection Proxy", + "operation": "Get HorizonDb private endpoint connection proxy", + "description": "Returns the properties for the specified HorizonDb private endpoint connection proxy." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/privateEndpointConnectionProxies/delete", + "display": { + "resource": "HorizonDb Private Endpoint Connection Proxy", + "operation": "Delete HorizonDb private endpoint connection proxy", + "description": "Deletes an existing HorizonDb private endpoint connection proxy." + } + }, + { + "name": "Microsoft.HorizonDb/locations/privateEndpointConnectionProxyAzureAsyncOperation/read", + "display": { + "resource": "HorizonDb Private Endpoint Connection Proxy", + "operation": "Get HorizonDb private endpoint connection proxy async operation status", + "description": "Gets the async status for a HorizonDb private endpoint connection proxy operation." + } + }, + { + "name": "Microsoft.HorizonDb/locations/privateEndpointConnectionProxyOperationResults/read", + "display": { + "resource": "HorizonDb Private Endpoint Connection Proxy", + "operation": "Get HorizonDb private endpoint connection proxy operation result", + "description": "Gets the result for a HorizonDb private endpoint connection proxy operation." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/privateEndpointConnectionProxies/validate/action", + "display": { + "resource": "HorizonDb Private Endpoint Connection Proxy", + "operation": "Validate HorizonDb private endpoint connection proxy creation by NRP", + "description": "Validates a HorizonDb private endpoint connection proxy creation request from NRP." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/systemAiModels/delete", + "display": { + "resource": "System AI Model", + "operation": "Delete System AI Model", + "description": "Deletes an existing System AI Model." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/systemAiModels/read", + "display": { + "resource": "System AI Model", + "operation": "Get System AI Model", + "description": "Gets the properties for the specified System AI Model." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/systemAiModels/read", + "display": { + "resource": "System AI Model", + "operation": "Get System AI Model", + "description": "Gets the properties for the specified System AI Model." + } } ] } diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_CreateOrUpdate.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_CreateOrUpdate.json index 109cfd4af90d..1891d988e934 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_CreateOrUpdate.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_CreateOrUpdate.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbParameterGroups_CreateOrUpdate", - "title": "Create or update a HorizonDb parameter group", + "title": "Create or update a HorizonDB parameter group", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_Delete.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_Delete.json index 763a74a51ad9..6abf22804eb7 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_Delete.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_Delete.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbParameterGroups_Delete", - "title": "Delete a HorizonDb parameter group", + "title": "Delete a HorizonDB parameter group", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_Get.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_Get.json index 8d30ecf5dee6..13c6590223f5 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_Get.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_Get.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbParameterGroups_Get", - "title": "Get a HorizonDb parameter group", + "title": "Get a HorizonDB parameter group", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_ListByResourceGroup.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_ListByResourceGroup.json index 7688ca2e78cd..ba2682ecd54b 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_ListByResourceGroup.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_ListByResourceGroup.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbParameterGroups_ListByResourceGroup", - "title": "List HorizonDb parameter groups in a resource group", + "title": "List HorizonDB parameter groups in a resource group", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_ListBySubscription.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_ListBySubscription.json index e63ab7b1d354..edea4b27eb40 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_ListBySubscription.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_ListBySubscription.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbParameterGroups_ListBySubscription", - "title": "List HorizonDb parameter groups in a subscription", + "title": "List HorizonDB parameter groups in a subscription", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "api-version": "2026-01-20-preview" @@ -83,7 +83,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testResourceGroup/providers/Microsoft.HorizonDb/parameterGroups/exampleparametergrouptest", "name": "exampleparametergrouptest", "type": "Microsoft.HorizonDb/parameterGroups", - "location": "centralus", + "location": "westus2", "tags": { "env": "test" }, diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_ListConnections.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_ListConnections.json index 33ef1ee49ee7..526bb2a32b97 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_ListConnections.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_ListConnections.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbParameterGroups_ListConnections", - "title": "List connections for a HorizonDb parameter group", + "title": "List connections for a HorizonDB parameter group", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_Update.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_Update.json index 12fb1d9f0352..da7f41428919 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_Update.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/ParameterGroups_Update.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbParameterGroups_Update", - "title": "Update a HorizonDb parameter group", + "title": "Update a HorizonDB parameter group", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Pools_Get.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Pools_Get.json index 950897b93508..6026f57d35a6 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Pools_Get.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Pools_Get.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbPools_Get", - "title": "Get a HorizonDb pool", + "title": "Get a HorizonDB pool", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Pools_List.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Pools_List.json index da04407e1ae6..941434b3ba5b 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Pools_List.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Pools_List.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbPools_List", - "title": "List HorizonDb pools in a cluster", + "title": "List HorizonDB pools in a cluster", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/PrivateLinkResources_Get.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/PrivateLinkResources_Get.json index 76e64baedbde..1fba70462aef 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/PrivateLinkResources_Get.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/PrivateLinkResources_Get.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbPrivateLinkResources_Get", - "title": "Gets a private link resource for HorizonDb", + "title": "Gets a private link resource for HorizonDB", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/PrivateLinkResources_List.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/PrivateLinkResources_List.json index 3e5e4904f8b7..4ca364cf6f17 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/PrivateLinkResources_List.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/PrivateLinkResources_List.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbPrivateLinkResources_List", - "title": "Gets private link resources for HorizonDb", + "title": "Gets private link resources for HorizonDB", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Replicas_CreateOrUpdate.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Replicas_CreateOrUpdate.json index 1137753abd78..07f15f455353 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Replicas_CreateOrUpdate.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Replicas_CreateOrUpdate.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbReplicas_CreateOrUpdate", - "title": "Create or update a HorizonDb replica", + "title": "Create or update a HorizonDB replica", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Replicas_Delete.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Replicas_Delete.json index 79549f7c99be..1c8090010aba 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Replicas_Delete.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Replicas_Delete.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbReplicas_Delete", - "title": "Delete a HorizonDb replica", + "title": "Delete a HorizonDB replica", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Replicas_Get.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Replicas_Get.json index fc4202cb9d3d..4439bf03d9c2 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Replicas_Get.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Replicas_Get.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbReplicas_Get", - "title": "Get a HorizonDb replica", + "title": "Get a HorizonDB replica", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Replicas_List.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Replicas_List.json index 81df79444e99..3cc683544eb6 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Replicas_List.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Replicas_List.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbReplicas_List", - "title": "List HorizonDb replicas in a pool", + "title": "List HorizonDB replicas in a pool", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Replicas_Update.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Replicas_Update.json index c63419ed9234..11132848b412 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Replicas_Update.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/examples/2026-01-20-preview/Replicas_Update.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbReplicas_Update", - "title": "Update a HorizonDb replica", + "title": "Update a HorizonDB replica", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/main.tsp b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/main.tsp index 21dd9a589a98..768365c6e71e 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/main.tsp +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/main.tsp @@ -9,10 +9,10 @@ using TypeSpec.Versioning; using Azure.ResourceManager; /** - * Azure Resource Provider API for managing HorizonDb clusters, pools, replicas, and firewall rules + * Azure Resource Provider API for managing HorizonDB clusters, pools, replicas, and firewall rules */ @armProviderNamespace -@service(#{ title: "Microsoft HorizonDb Management API" }) +@service(#{ title: "Microsoft HorizonDB Management API" }) @versioned(Versions) @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v6) namespace Microsoft.HorizonDb; diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/models.tsp b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/models.tsp index e8e802c647aa..b2a1a4d9a6fb 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/models.tsp +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/models.tsp @@ -9,10 +9,10 @@ using Azure.ResourceManager; namespace Microsoft.HorizonDb; -@doc("Represents the HorizonDb cluster.") +@doc("Represents the HorizonDB cluster.") model HorizonDbCluster is Azure.ResourceManager.TrackedResource { - @doc("The name of the HorizonDb cluster.") + @doc("The name of the HorizonDB cluster.") @pattern("^[a-zA-Z0-9][-a-zA-Z0-9]*[a-zA-Z0-9]$") @minLength(1) @maxLength(63) @@ -22,13 +22,13 @@ model HorizonDbCluster name: string; } -@doc("Represents the HorizonDb pool.") +@doc("Represents the HorizonDB pool.") @parentResource(HorizonDbCluster) model HorizonDbPool is Azure.ResourceManager.ProxyResource { ...Azure.ResourceManager.Foundations.ArmTagsProperty; - @doc("The name of the HorizonDb pool.") + @doc("The name of the HorizonDB pool.") @pattern("^[a-zA-Z0-9][-a-zA-Z0-9]*[a-zA-Z0-9]$") @minLength(1) @maxLength(63) @@ -38,11 +38,11 @@ model HorizonDbPool name: string; } -@doc("Represents the HorizonDb replica.") +@doc("Represents the HorizonDB replica.") @parentResource(HorizonDbPool) model HorizonDbReplica is Azure.ResourceManager.ProxyResource { - @doc("The name of the HorizonDb replica.") + @doc("The name of the HorizonDB replica.") @pattern("^[a-zA-Z0-9][-a-zA-Z0-9]*[a-zA-Z0-9]$") @minLength(1) @maxLength(63) @@ -52,11 +52,11 @@ model HorizonDbReplica name: string; } -@doc("Represents the HorizonDb firewall rule.") +@doc("Represents the HorizonDB firewall rule.") @parentResource(HorizonDbPool) model HorizonDbFirewallRule is Azure.ResourceManager.ProxyResource { - @doc("The name of the HorizonDb firewall rule.") + @doc("The name of the HorizonDB firewall rule.") @pattern("^[a-zA-Z0-9][-a-zA-Z0-9]*[a-zA-Z0-9]$") @minLength(1) @maxLength(128) @@ -66,7 +66,7 @@ model HorizonDbFirewallRule name: string; } -@doc("Represents the HorizonDb private link resource.") +@doc("Represents the HorizonDB private link resource.") @parentResource(HorizonDbCluster) model HorizonDbPrivateLinkResource is Azure.ResourceManager.ProxyResource { @@ -80,10 +80,10 @@ model HorizonDbPrivateLinkResource name: string; } -@doc("Represents the HorizonDb parameter group.") +@doc("Represents the HorizonDB parameter group.") model HorizonDbParameterGroup is Azure.ResourceManager.TrackedResource { - @doc("The name of the HorizonDb parameter group.") + @doc("The name of the HorizonDB parameter group.") @pattern("^[a-zA-Z0-9][-a-zA-Z0-9]*[a-zA-Z0-9]$") @minLength(1) @maxLength(63) @@ -93,7 +93,7 @@ model HorizonDbParameterGroup name: string; } -@doc("Properties of a HorizonDb cluster.") +@doc("Properties of a HorizonDB cluster.") model HorizonDbClusterProperties { @doc("The administrator login name.") @minLength(1) @@ -108,10 +108,10 @@ model HorizonDbClusterProperties { @visibility(Lifecycle.Create, Lifecycle.Update) administratorLoginPassword?: string; - @doc("The version of the HorizonDb cluster.") + @doc("The version of the HorizonDB cluster.") version?: string; - @doc("The mode to create a new HorizonDb cluster.") + @doc("The mode to create a new HorizonDB cluster.") createMode?: CreateModeCluster; #suppress "@azure-tools/typespec-azure-core/casing-style" "UTC is a well-established acronym for Coordinated Universal Time and should remain uppercase for clarity and consistency with Azure service conventions" @@ -135,7 +135,7 @@ model HorizonDbClusterProperties { @visibility(Lifecycle.Create, Lifecycle.Update, Lifecycle.Read) vCores?: int32; - @doc("The processor type for the HorizonDb cluster.") + @doc("The processor type for the HorizonDB cluster.") processorType?: string; @doc("The network related info.") @@ -166,7 +166,7 @@ model HorizonDbClusterProperties { parameterGroup?: HorizonDbClusterParameterGroupConnectionProperties; } -@doc("Properties of a HorizonDb cluster for update operations.") +@doc("Properties of a HorizonDB cluster for update operations.") model HorizonDbClusterPropertiesForPatchUpdate { @secret @minLength(8) @@ -185,17 +185,17 @@ model HorizonDbClusterPropertiesForPatchUpdate { parameterGroup?: HorizonDbClusterParameterGroupConnectionProperties; } -@doc("HorizonDb cluster for update operations.") +@doc("HorizonDB cluster for update operations.") model HorizonDbClusterForPatchUpdate { ...Azure.ResourceManager.Foundations.ArmTagsProperty; - @doc("The properties that can be updated for a HorizonDb cluster.") + @doc("The properties that can be updated for a HorizonDB cluster.") properties?: HorizonDbClusterPropertiesForPatchUpdate; } -@doc("Properties of a HorizonDb pool.") +@doc("Properties of a HorizonDB pool.") model HorizonDbPoolProperties { - @doc("The location of the HorizonDb pool.") + @doc("The location of the HorizonDB pool.") @visibility(Lifecycle.Create, Lifecycle.Read) location?: azureLocation; @@ -207,7 +207,7 @@ model HorizonDbPoolProperties { @visibility(Lifecycle.Read) replicaCount?: int32; - @doc("The version of the HorizonDb pool.") + @doc("The version of the HorizonDB pool.") @visibility(Lifecycle.Read) version?: string; @@ -228,7 +228,7 @@ model Network { publicNetworkAccess?: PublicNetworkAccessState; } -@doc("Properties of a HorizonDb replica.") +@doc("Properties of a HorizonDB replica.") model HorizonDbReplicaProperties { @doc("Role of the replica.") @visibility(Lifecycle.Read, Lifecycle.Create, Lifecycle.Update) @@ -250,20 +250,20 @@ model HorizonDbReplicaProperties { provisioningState?: ProvisioningState; } -@doc("Properties of a HorizonDb replica for update operations.") +@doc("Properties of a HorizonDB replica for update operations.") model HorizonDbReplicaPropertiesForPatchUpdate { @visibility(Lifecycle.Update) @doc("Role of the replica.") role?: ReplicaRole; } -@doc("HorizonDb replica for update operations.") +@doc("HorizonDB replica for update operations.") model HorizonDbReplicaForPatchUpdate { - @doc("Properties of a HorizonDb replica for update operations.") + @doc("Properties of a HorizonDB replica for update operations.") properties?: HorizonDbReplicaPropertiesForPatchUpdate; } -@doc("Properties of a HorizonDb firewall rule.") +@doc("Properties of a HorizonDB firewall rule.") model HorizonDbFirewallRuleProperties { @doc("The start IP address of the firewall rule (IPv4).") @visibility(Lifecycle.Create, Lifecycle.Update, Lifecycle.Read) @@ -273,7 +273,7 @@ model HorizonDbFirewallRuleProperties { @visibility(Lifecycle.Create, Lifecycle.Update, Lifecycle.Read) endIpAddress: string; - @doc("The description of the HorizonDb firewall rule.") + @doc("The description of the HorizonDB firewall rule.") @visibility(Lifecycle.Create, Lifecycle.Update, Lifecycle.Read) description?: string; @@ -282,7 +282,7 @@ model HorizonDbFirewallRuleProperties { provisioningState?: ProvisioningState; } -@doc("The mode to create a new HorizonDb cluster.") +@doc("The mode to create a new HorizonDB cluster.") union CreateModeCluster { string, @@ -296,7 +296,7 @@ union CreateModeCluster { PointInTimeRestore: "PointInTimeRestore", } -@doc("The mode to create a new HorizonDb cluster.") +@doc("The mode to create a new HorizonDB cluster.") union CreateModePool { string, @@ -389,7 +389,7 @@ union ProvisioningState { Provisioning: "Provisioning", } -@doc("Properties of a HorizonDb parameter group.") +@doc("Properties of a HorizonDB parameter group.") model HorizonDbParameterGroupProperties { @doc("Parameters in the parameter group.") @identifiers(#["name"]) @@ -417,7 +417,7 @@ model HorizonDbParameterGroupProperties { provisioningState?: ProvisioningState; } -@doc("Properties of a HorizonDb parameters.") +@doc("Properties of a HorizonDB parameters.") model ParameterProperties { @doc("The name of the parameter.") name?: string; @@ -454,7 +454,7 @@ model ParameterProperties { unit?: string; } -@doc("Properties of a HorizonDb parameter group for update operations.") +@doc("Properties of a HorizonDB parameter group for update operations.") model HorizonDbParameterGroupPropertiesForPatchUpdate { @doc("Parameters in the parameter group.") @identifiers(#["name"]) @@ -470,15 +470,15 @@ model HorizonDbParameterGroupPropertiesForPatchUpdate { applyImmediately?: boolean; } -@doc("HorizonDb parameter group for update operations.") +@doc("HorizonDB parameter group for update operations.") model HorizonDbParameterGroupForPatchUpdate { ...Azure.ResourceManager.Foundations.ArmTagsProperty; - @doc("The properties that can be updated for a HorizonDb parameter group.") + @doc("The properties that can be updated for a HorizonDB parameter group.") properties?: HorizonDbParameterGroupPropertiesForPatchUpdate; } -@doc("Connection information for HorizonDb parameter group.") +@doc("Connection information for HorizonDB parameter group.") model HorizonDbParameterGroupConnectionProperties { @doc("The name of the connected resource.") @visibility(Lifecycle.Read) @@ -493,13 +493,13 @@ model HorizonDbParameterGroupConnectionProperties { type?: string; } -@doc("Connection information for HorizonDb parameter group.") +@doc("Connection information for HorizonDB parameter group.") model HorizonDbClusterParameterGroupConnectionProperties { @doc("The resource ID of the connected parameter group.") @visibility(Lifecycle.Update, Lifecycle.Read) id?: armResourceIdentifier; - @doc("Indication of if parameter group is applied on HorizonDb resource.") + @doc("Indication of if parameter group is applied on HorizonDB resource.") @visibility(Lifecycle.Read) syncStatus?: string; diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_CreateOrUpdate.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_CreateOrUpdate.json index a7b0fe93e5c8..e80ed8fb06dc 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_CreateOrUpdate.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_CreateOrUpdate.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbClusters_CreateOrUpdate", - "title": "Create or update a HorizonDb cluster", + "title": "Create or update a HorizonDB cluster", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", @@ -13,13 +13,12 @@ }, "properties": { "createMode": "Create", - "sourceClusterResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/examplesourceresourcegroup/providers/Microsoft.HorizonDb/clusters/examplesourcecluster", "version": "17", "administratorLogin": "exampleadministratorlogin", "administratorLoginPassword": "examplepassword", "vCores": 4, "replicaCount": 2, - "zonePlacementPolicy": "Strict" + "zonePlacementPolicy": "BestEffort" } } }, @@ -37,13 +36,12 @@ "administratorLogin": "exampleadministratorlogin", "version": "17", "createMode": "Create", - "sourceClusterResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/examplesourceresourcegroup/providers/Microsoft.HorizonDb/clusters/examplesourcecluster", "vCores": 4, "replicaCount": 2, - "zonePlacementPolicy": "Strict", + "zonePlacementPolicy": "BestEffort", "state": "Ready", - "fullyQualifiedDomainName": "examplecluster.westus2.horizondb.azure.com", - "readonlyEndpoint": "examplecluster-ro.horizondb.azure.com", + "fullyQualifiedDomainName": "examplecluster.ffffffffffff.westus2.horizondb.azure.com", + "readonlyEndpoint": "examplecluster.ffffffffffff-ro.horizondb.azure.com", "provisioningState": "Succeeded" } } @@ -61,10 +59,9 @@ "administratorLogin": "exampleadministratorlogin", "version": "17", "createMode": "Create", - "sourceClusterResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/examplesourceresourcegroup/providers/Microsoft.HorizonDb/clusters/examplesourcecluster", "vCores": 4, "replicaCount": 2, - "zonePlacementPolicy": "Strict", + "zonePlacementPolicy": "BestEffort", "provisioningState": "Provisioning" } } diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_Delete.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_Delete.json index edb111450fff..6c770b7c026a 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_Delete.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_Delete.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbClusters_Delete", - "title": "Delete a HorizonDb cluster", + "title": "Delete a HorizonDB cluster", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_Get.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_Get.json index b189c0218c33..21b28cc9f4c4 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_Get.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_Get.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbClusters_Get", - "title": "Get a HorizonDb cluster", + "title": "Get a HorizonDB cluster", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", @@ -22,10 +22,10 @@ "version": "17", "vCores": 4, "replicaCount": 2, - "zonePlacementPolicy": "Strict", + "zonePlacementPolicy": "BestEffort", "state": "Ready", - "fullyQualifiedDomainName": "examplecluster.westus2.horizondb.azure.com", - "readonlyEndpoint": "examplecluster-ro.horizondb.azure.com", + "fullyQualifiedDomainName": "examplecluster.ffffffffffff.westus2.horizondb.azure.com", + "readonlyEndpoint": "examplecluster.ffffffffffff-ro.horizondb.azure.com", "provisioningState": "Succeeded" } } diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_ListByResourceGroup.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_ListByResourceGroup.json index 9bdf12046646..d6b488341303 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_ListByResourceGroup.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_ListByResourceGroup.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbClusters_ListByResourceGroup", - "title": "List HorizonDb clusters in a resource group", + "title": "List HorizonDB clusters in a resource group", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", @@ -23,9 +23,9 @@ "version": "17", "vCores": 4, "replicaCount": 2, - "zonePlacementPolicy": "Strict", + "zonePlacementPolicy": "BestEffort", "state": "Ready", - "fullyQualifiedDomainName": "examplecluster.westus2.horizondb.azure.com", + "fullyQualifiedDomainName": "examplecluster.ffffffffffff.westus2.horizondb.azure.com", "readonlyEndpoint": "examplecluster-ro.westus2.horizondb.azure.com", "provisioningState": "Succeeded" } @@ -43,7 +43,7 @@ "version": "17", "vCores": 2, "replicaCount": 1, - "zonePlacementPolicy": "Strict", + "zonePlacementPolicy": "BestEffort", "state": "Ready", "fullyQualifiedDomainName": "examplecluster2.westus2.horizondb.azure.com", "readonlyEndpoint": "examplecluster2-ro.westus2.horizondb.azure.com", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_ListBySubscription.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_ListBySubscription.json index c5d2ab4ff2c1..312f5793b9e8 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_ListBySubscription.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_ListBySubscription.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbClusters_ListBySubscription", - "title": "List HorizonDb clusters by subscription", + "title": "List HorizonDB clusters by subscription", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "api-version": "2026-01-20-preview" @@ -22,9 +22,9 @@ "version": "17", "vCores": 4, "replicaCount": 2, - "zonePlacementPolicy": "Strict", + "zonePlacementPolicy": "BestEffort", "state": "Ready", - "fullyQualifiedDomainName": "examplecluster.westus2.horizondb.azure.com", + "fullyQualifiedDomainName": "examplecluster.ffffffffffff.westus2.horizondb.azure.com", "readonlyEndpoint": "examplecluster-ro.westus2.horizondb.azure.com", "provisioningState": "Succeeded" } @@ -42,7 +42,7 @@ "version": "17", "vCores": 2, "replicaCount": 1, - "zonePlacementPolicy": "Strict", + "zonePlacementPolicy": "BestEffort", "state": "Ready", "fullyQualifiedDomainName": "examplecluster2.westus2.horizondb.azure.com", "readonlyEndpoint": "examplecluster2-ro.westus2.horizondb.azure.com", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_Update.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_Update.json index 920dc54a9ae0..5f97235385e6 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_Update.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Clusters_Update.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbClusters_Update", - "title": "Update a HorizonDb cluster", + "title": "Update a HorizonDB cluster", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", @@ -33,9 +33,9 @@ "createMode": "Update", "vCores": 8, "replicaCount": 2, - "zonePlacementPolicy": "Strict", + "zonePlacementPolicy": "BestEffort", "state": "Ready", - "fullyQualifiedDomainName": "examplecluster.westus2.horizondb.azure.com", + "fullyQualifiedDomainName": "examplecluster.ffffffffffff.westus2.horizondb.azure.com", "readonlyEndpoint": "examplecluster-ro.westus2.horizondb.azure.com", "provisioningState": "Succeeded" } diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/FirewallRules_CreateOrUpdate.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/FirewallRules_CreateOrUpdate.json index 6c7f6c519745..95d8e5ea4d2a 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/FirewallRules_CreateOrUpdate.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/FirewallRules_CreateOrUpdate.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbFirewallRules_CreateOrUpdate", - "title": "Create or update a HorizonDb firewall rule", + "title": "Create or update a HorizonDB firewall rule", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/FirewallRules_Delete.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/FirewallRules_Delete.json index 91746b5fa2bc..872db101ebe2 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/FirewallRules_Delete.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/FirewallRules_Delete.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbFirewallRules_Delete", - "title": "Delete a HorizonDb firewall rule", + "title": "Delete a HorizonDB firewall rule", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/FirewallRules_Get.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/FirewallRules_Get.json index 51fd72fb0197..52c4cf8bd7dd 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/FirewallRules_Get.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/FirewallRules_Get.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbFirewallRules_Get", - "title": "Get a HorizonDb firewall rule", + "title": "Get a HorizonDB firewall rule", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/FirewallRules_List.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/FirewallRules_List.json index 3375924f05e4..0c827fbc4184 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/FirewallRules_List.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/FirewallRules_List.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbFirewallRules_List", - "title": "List HorizonDb firewall rules in a pool", + "title": "List HorizonDB firewall rules in a pool", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Operations_List.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Operations_List.json index 107105b97d2b..6a1b50064a3d 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Operations_List.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Operations_List.json @@ -1,6 +1,6 @@ { "operationId": "Operations_List", - "title": "List operations for Microsoft.HorizonDb", + "title": "List operations for Microsoft.HorizonDB", "parameters": { "api-version": "2026-01-20-preview" }, @@ -9,37 +9,276 @@ "body": { "value": [ { - "name": "Microsoft.HorizonDb/clusters/read", - "isDataAction": false, + "name": "Microsoft.HorizonDb/clusters/write", "display": { - "provider": "Microsoft HorizonDb", - "resource": "HorizonDb Clusters", - "operation": "Get/List HorizonDb clusters", - "description": "Retrieves the properties of the specified HorizonDb clusters." - }, - "origin": "user,system" + "resource": "HorizonDb Cluster", + "operation": "Create/Update HorizonDb cluster", + "description": "Creates a HorizonDb cluster with the specified parameters or update the properties or tags for the specified cluster." + } }, { "name": "Microsoft.HorizonDb/clusters/write", - "isDataAction": false, "display": { - "provider": "Microsoft HorizonDb", - "resource": "HorizonDb Clusters", + "resource": "HorizonDb Cluster", "operation": "Create/Update HorizonDb cluster", - "description": "Creates a new HorizonDb cluster or updates an existing one." - }, - "origin": "user,system" + "description": "Creates a HorizonDb cluster with the specified parameters or update the properties or tags for the specified cluster." + } }, { "name": "Microsoft.HorizonDb/clusters/delete", - "isDataAction": false, "display": { - "provider": "Microsoft HorizonDb", - "resource": "HorizonDb Clusters", + "resource": "HorizonDb Cluster", "operation": "Delete HorizonDb cluster", - "description": "Deletes a HorizonDb cluster." - }, - "origin": "user,system" + "description": "Deletes an existing HorizonDb cluster." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/read", + "display": { + "resource": "HorizonDb Cluster", + "operation": "List/Get HorizonDb cluster", + "description": "Return the list of HorizonDb clusters or gets the properties for the specified cluster." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/read", + "display": { + "resource": "HorizonDb Cluster", + "operation": "List HorizonDb clusters in subscription", + "description": "Lists all HorizonDb clusters in the subscription." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/pools/replicas/write", + "display": { + "resource": "HorizonDb Replica", + "operation": "Create/Update HorizonDb replica", + "description": "Creates or updates a HorizonDb replica with the specified parameters." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/pools/replicas/read", + "display": { + "resource": "HorizonDb Replica", + "operation": "Get HorizonDb replica", + "description": "Gets the properties for the specified HorizonDb replica." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/pools/replicas/delete", + "display": { + "resource": "HorizonDb Replica", + "operation": "Delete HorizonDb replica", + "description": "Deletes an existing HorizonDb replica." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/pools/replicas/write", + "display": { + "resource": "HorizonDb Replica", + "operation": "Create/Update HorizonDb replica", + "description": "Creates or updates a HorizonDb replica with the specified parameters." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/effectiveParameters/read", + "display": { + "resource": "HorizonDb Cluster Effective Parameters", + "operation": "Get HorizonDb cluster effective parameters", + "description": "Gets the effective (parameter group merged with per-cluster overrides) parameter set for a HorizonDb cluster." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/read", + "display": { + "resource": "HorizonDb Cluster", + "operation": "List HorizonDb clusters in subscription", + "description": "Lists all HorizonDb clusters in the subscription." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/pools/firewallRules/write", + "display": { + "resource": "HorizonDb Firewall Rule", + "operation": "Create/Update HorizonDb firewall rule", + "description": "Creates or updates a HorizonDb firewall rule with the specified parameters." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/pools/firewallRules/delete", + "display": { + "resource": "HorizonDb Firewall Rule", + "operation": "Delete HorizonDb firewall rule", + "description": "Deletes an existing HorizonDb firewall rule." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/pools/firewallRules/read", + "display": { + "resource": "HorizonDb Firewall Rule", + "operation": "List HorizonDb firewall rules", + "description": "Lists all firewall rules for the specified HorizonDb pool." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/pools/firewallRules/read", + "display": { + "resource": "HorizonDb Firewall Rule", + "operation": "Get HorizonDb firewall rule", + "description": "Gets the properties for the specified HorizonDb firewall rule." + } + }, + { + "name": "Microsoft.HorizonDb/parameterGroups/write", + "display": { + "resource": "HorizonDb Parameter Group", + "operation": "Create/Update HorizonDb parameter group", + "description": "Creates or updates a HorizonDb parameter group with the specified parameters." + } + }, + { + "name": "Microsoft.HorizonDb/parameterGroups/write", + "display": { + "resource": "HorizonDb Parameter Group", + "operation": "Create/Update HorizonDb parameter group", + "description": "Creates or updates a HorizonDb parameter group with the specified parameters." + } + }, + { + "name": "Microsoft.HorizonDb/parameterGroups/delete", + "display": { + "resource": "HorizonDb Parameter Group", + "operation": "Delete HorizonDb parameter group", + "description": "Deletes an existing HorizonDb parameter group." + } + }, + { + "name": "Microsoft.HorizonDb/parameterGroups/read", + "display": { + "resource": "HorizonDb Parameter Group", + "operation": "Get HorizonDb parameter group", + "description": "Gets the properties for the specified HorizonDb parameter group." + } + }, + { + "name": "Microsoft.HorizonDb/parameterGroups/connections/read", + "display": { + "resource": "HorizonDb Parameter Group", + "operation": "Get HorizonDb parameter group connections", + "description": "Gets the clusters connected to a HorizonDb parameter group." + } + }, + { + "name": "Microsoft.HorizonDb/parameterGroups/read", + "display": { + "resource": "HorizonDb Parameter Group", + "operation": "List HorizonDb parameter groups in subscription", + "description": "Lists all HorizonDb parameter groups in the subscription." + } + }, + { + "name": "Microsoft.HorizonDb/parameterGroups/versions/read", + "display": { + "resource": "HorizonDb Parameter Group", + "operation": "Get HorizonDb parameter group versions", + "description": "Gets the versions of a HorizonDb parameter group." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/pools/write", + "display": { + "resource": "HorizonDb Pool", + "operation": "Create/Update HorizonDb pool", + "description": "Creates or updates a HorizonDb pool with the specified parameters." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/pools/delete", + "display": { + "resource": "HorizonDb Pool", + "operation": "Delete HorizonDb pool", + "description": "Deletes an existing HorizonDb pool." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/pools/write", + "display": { + "resource": "HorizonDb Pool", + "operation": "Create/Update HorizonDb pool", + "description": "Creates or updates a HorizonDb pool with the specified parameters." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/privateEndpointConnectionProxies/write", + "display": { + "resource": "HorizonDb Private Endpoint Connection Proxy", + "operation": "Create/Update HorizonDb private endpoint connection proxy", + "description": "Creates or updates a HorizonDb private endpoint connection proxy." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/privateEndpointConnectionProxies/read", + "display": { + "resource": "HorizonDb Private Endpoint Connection Proxy", + "operation": "Get HorizonDb private endpoint connection proxy", + "description": "Returns the properties for the specified HorizonDb private endpoint connection proxy." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/privateEndpointConnectionProxies/delete", + "display": { + "resource": "HorizonDb Private Endpoint Connection Proxy", + "operation": "Delete HorizonDb private endpoint connection proxy", + "description": "Deletes an existing HorizonDb private endpoint connection proxy." + } + }, + { + "name": "Microsoft.HorizonDb/locations/privateEndpointConnectionProxyAzureAsyncOperation/read", + "display": { + "resource": "HorizonDb Private Endpoint Connection Proxy", + "operation": "Get HorizonDb private endpoint connection proxy async operation status", + "description": "Gets the async status for a HorizonDb private endpoint connection proxy operation." + } + }, + { + "name": "Microsoft.HorizonDb/locations/privateEndpointConnectionProxyOperationResults/read", + "display": { + "resource": "HorizonDb Private Endpoint Connection Proxy", + "operation": "Get HorizonDb private endpoint connection proxy operation result", + "description": "Gets the result for a HorizonDb private endpoint connection proxy operation." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/privateEndpointConnectionProxies/validate/action", + "display": { + "resource": "HorizonDb Private Endpoint Connection Proxy", + "operation": "Validate HorizonDb private endpoint connection proxy creation by NRP", + "description": "Validates a HorizonDb private endpoint connection proxy creation request from NRP." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/systemAiModels/delete", + "display": { + "resource": "System AI Model", + "operation": "Delete System AI Model", + "description": "Deletes an existing System AI Model." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/systemAiModels/read", + "display": { + "resource": "System AI Model", + "operation": "Get System AI Model", + "description": "Gets the properties for the specified System AI Model." + } + }, + { + "name": "Microsoft.HorizonDb/clusters/systemAiModels/read", + "display": { + "resource": "System AI Model", + "operation": "Get System AI Model", + "description": "Gets the properties for the specified System AI Model." + } } ] } diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_CreateOrUpdate.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_CreateOrUpdate.json index 109cfd4af90d..1891d988e934 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_CreateOrUpdate.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_CreateOrUpdate.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbParameterGroups_CreateOrUpdate", - "title": "Create or update a HorizonDb parameter group", + "title": "Create or update a HorizonDB parameter group", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_Delete.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_Delete.json index 763a74a51ad9..6abf22804eb7 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_Delete.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_Delete.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbParameterGroups_Delete", - "title": "Delete a HorizonDb parameter group", + "title": "Delete a HorizonDB parameter group", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_Get.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_Get.json index 8d30ecf5dee6..13c6590223f5 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_Get.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_Get.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbParameterGroups_Get", - "title": "Get a HorizonDb parameter group", + "title": "Get a HorizonDB parameter group", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_ListByResourceGroup.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_ListByResourceGroup.json index 7688ca2e78cd..ba2682ecd54b 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_ListByResourceGroup.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_ListByResourceGroup.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbParameterGroups_ListByResourceGroup", - "title": "List HorizonDb parameter groups in a resource group", + "title": "List HorizonDB parameter groups in a resource group", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_ListBySubscription.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_ListBySubscription.json index e63ab7b1d354..edea4b27eb40 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_ListBySubscription.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_ListBySubscription.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbParameterGroups_ListBySubscription", - "title": "List HorizonDb parameter groups in a subscription", + "title": "List HorizonDB parameter groups in a subscription", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "api-version": "2026-01-20-preview" @@ -83,7 +83,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testResourceGroup/providers/Microsoft.HorizonDb/parameterGroups/exampleparametergrouptest", "name": "exampleparametergrouptest", "type": "Microsoft.HorizonDb/parameterGroups", - "location": "centralus", + "location": "westus2", "tags": { "env": "test" }, diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_ListConnections.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_ListConnections.json index 33ef1ee49ee7..526bb2a32b97 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_ListConnections.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_ListConnections.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbParameterGroups_ListConnections", - "title": "List connections for a HorizonDb parameter group", + "title": "List connections for a HorizonDB parameter group", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_Update.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_Update.json index 12fb1d9f0352..da7f41428919 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_Update.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/ParameterGroups_Update.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbParameterGroups_Update", - "title": "Update a HorizonDb parameter group", + "title": "Update a HorizonDB parameter group", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Pools_Get.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Pools_Get.json index 950897b93508..6026f57d35a6 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Pools_Get.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Pools_Get.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbPools_Get", - "title": "Get a HorizonDb pool", + "title": "Get a HorizonDB pool", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Pools_List.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Pools_List.json index da04407e1ae6..941434b3ba5b 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Pools_List.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Pools_List.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbPools_List", - "title": "List HorizonDb pools in a cluster", + "title": "List HorizonDB pools in a cluster", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/PrivateLinkResources_Get.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/PrivateLinkResources_Get.json index 76e64baedbde..1fba70462aef 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/PrivateLinkResources_Get.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/PrivateLinkResources_Get.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbPrivateLinkResources_Get", - "title": "Gets a private link resource for HorizonDb", + "title": "Gets a private link resource for HorizonDB", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/PrivateLinkResources_List.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/PrivateLinkResources_List.json index 3e5e4904f8b7..4ca364cf6f17 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/PrivateLinkResources_List.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/PrivateLinkResources_List.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbPrivateLinkResources_List", - "title": "Gets private link resources for HorizonDb", + "title": "Gets private link resources for HorizonDB", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Replicas_CreateOrUpdate.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Replicas_CreateOrUpdate.json index 1137753abd78..07f15f455353 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Replicas_CreateOrUpdate.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Replicas_CreateOrUpdate.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbReplicas_CreateOrUpdate", - "title": "Create or update a HorizonDb replica", + "title": "Create or update a HorizonDB replica", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Replicas_Delete.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Replicas_Delete.json index 79549f7c99be..1c8090010aba 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Replicas_Delete.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Replicas_Delete.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbReplicas_Delete", - "title": "Delete a HorizonDb replica", + "title": "Delete a HorizonDB replica", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Replicas_Get.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Replicas_Get.json index fc4202cb9d3d..4439bf03d9c2 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Replicas_Get.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Replicas_Get.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbReplicas_Get", - "title": "Get a HorizonDb replica", + "title": "Get a HorizonDB replica", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Replicas_List.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Replicas_List.json index 81df79444e99..3cc683544eb6 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Replicas_List.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Replicas_List.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbReplicas_List", - "title": "List HorizonDb replicas in a pool", + "title": "List HorizonDB replicas in a pool", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Replicas_Update.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Replicas_Update.json index c63419ed9234..11132848b412 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Replicas_Update.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/examples/Replicas_Update.json @@ -1,6 +1,6 @@ { "operationId": "HorizonDbReplicas_Update", - "title": "Update a HorizonDb replica", + "title": "Update a HorizonDB replica", "parameters": { "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "resourceGroupName": "exampleresourcegroup", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/openapi.json b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/openapi.json index 1731e491f97c..6c34fe3388c4 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/openapi.json +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/preview/2026-01-20-preview/openapi.json @@ -1,9 +1,9 @@ { "swagger": "2.0", "info": { - "title": "Microsoft HorizonDb Management API", + "title": "Microsoft HorizonDB Management API", "version": "2026-01-20-preview", - "description": "Azure Resource Provider API for managing HorizonDb clusters, pools, replicas, and firewall rules", + "description": "Azure Resource Provider API for managing HorizonDB clusters, pools, replicas, and firewall rules", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" @@ -92,7 +92,7 @@ } }, "x-ms-examples": { - "List operations for Microsoft.HorizonDb": { + "List operations for Microsoft.HorizonDB": { "$ref": "./examples/Operations_List.json" } }, @@ -107,7 +107,7 @@ "tags": [ "HorizonDbClusters" ], - "description": "Lists all HorizonDb clusters in a subscription.", + "description": "Lists all HorizonDB clusters in a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -131,7 +131,7 @@ } }, "x-ms-examples": { - "List HorizonDb clusters by subscription": { + "List HorizonDB clusters by subscription": { "$ref": "./examples/Clusters_ListBySubscription.json" } }, @@ -146,7 +146,7 @@ "tags": [ "HorizonDbParameterGroups" ], - "description": "Lists all HorizonDb parameter groups in a subscription.", + "description": "Lists all HorizonDB parameter groups in a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -170,7 +170,7 @@ } }, "x-ms-examples": { - "List HorizonDb parameter groups in a subscription": { + "List HorizonDB parameter groups in a subscription": { "$ref": "./examples/ParameterGroups_ListBySubscription.json" } }, @@ -185,7 +185,7 @@ "tags": [ "HorizonDbClusters" ], - "description": "Lists all HorizonDb clusters in a resource group.", + "description": "Lists all HorizonDB clusters in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -212,7 +212,7 @@ } }, "x-ms-examples": { - "List HorizonDb clusters in a resource group": { + "List HorizonDB clusters in a resource group": { "$ref": "./examples/Clusters_ListByResourceGroup.json" } }, @@ -227,7 +227,7 @@ "tags": [ "HorizonDbClusters" ], - "description": "Gets information about a HorizonDb cluster.", + "description": "Gets information about a HorizonDB cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -241,7 +241,7 @@ { "name": "clusterName", "in": "path", - "description": "The name of the HorizonDb cluster.", + "description": "The name of the HorizonDB cluster.", "required": true, "type": "string", "minLength": 1, @@ -264,7 +264,7 @@ } }, "x-ms-examples": { - "Get a HorizonDb cluster": { + "Get a HorizonDB cluster": { "$ref": "./examples/Clusters_Get.json" } } @@ -274,7 +274,7 @@ "tags": [ "HorizonDbClusters" ], - "description": "Creates a new HorizonDb cluster or updates an existing cluster.", + "description": "Creates a new HorizonDB cluster or updates an existing cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -288,7 +288,7 @@ { "name": "clusterName", "in": "path", - "description": "The name of the HorizonDb cluster.", + "description": "The name of the HorizonDB cluster.", "required": true, "type": "string", "minLength": 1, @@ -337,7 +337,7 @@ } }, "x-ms-examples": { - "Create or update a HorizonDb cluster": { + "Create or update a HorizonDB cluster": { "$ref": "./examples/Clusters_CreateOrUpdate.json" } }, @@ -352,7 +352,7 @@ "tags": [ "HorizonDbClusters" ], - "description": "Updates an existing HorizonDb cluster (e.g., tags, virtual cores, replica count).", + "description": "Updates an existing HorizonDB cluster (e.g., tags, virtual cores, replica count).", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -366,7 +366,7 @@ { "name": "clusterName", "in": "path", - "description": "The name of the HorizonDb cluster.", + "description": "The name of the HorizonDB cluster.", "required": true, "type": "string", "minLength": 1, @@ -412,7 +412,7 @@ } }, "x-ms-examples": { - "Update a HorizonDb cluster": { + "Update a HorizonDB cluster": { "$ref": "./examples/Clusters_Update.json" } }, @@ -427,7 +427,7 @@ "tags": [ "HorizonDbClusters" ], - "description": "Deletes a HorizonDb cluster.", + "description": "Deletes a HorizonDB cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -441,7 +441,7 @@ { "name": "clusterName", "in": "path", - "description": "The name of the HorizonDb cluster.", + "description": "The name of the HorizonDB cluster.", "required": true, "type": "string", "minLength": 1, @@ -480,7 +480,7 @@ } }, "x-ms-examples": { - "Delete a HorizonDb cluster": { + "Delete a HorizonDB cluster": { "$ref": "./examples/Clusters_Delete.json" } }, @@ -496,7 +496,7 @@ "tags": [ "HorizonDbPools" ], - "description": "Lists all HorizonDb pools in a cluster.", + "description": "Lists all HorizonDB pools in a cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -510,7 +510,7 @@ { "name": "clusterName", "in": "path", - "description": "The name of the HorizonDb cluster.", + "description": "The name of the HorizonDB cluster.", "required": true, "type": "string", "minLength": 1, @@ -533,7 +533,7 @@ } }, "x-ms-examples": { - "List HorizonDb pools in a cluster": { + "List HorizonDB pools in a cluster": { "$ref": "./examples/Pools_List.json" } }, @@ -548,7 +548,7 @@ "tags": [ "HorizonDbPools" ], - "description": "Gets information about a HorizonDb pool.", + "description": "Gets information about a HorizonDB pool.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -562,7 +562,7 @@ { "name": "clusterName", "in": "path", - "description": "The name of the HorizonDb cluster.", + "description": "The name of the HorizonDB cluster.", "required": true, "type": "string", "minLength": 1, @@ -572,7 +572,7 @@ { "name": "poolName", "in": "path", - "description": "The name of the HorizonDb pool.", + "description": "The name of the HorizonDB pool.", "required": true, "type": "string", "minLength": 1, @@ -595,7 +595,7 @@ } }, "x-ms-examples": { - "Get a HorizonDb pool": { + "Get a HorizonDB pool": { "$ref": "./examples/Pools_Get.json" } } @@ -607,7 +607,7 @@ "tags": [ "HorizonDbFirewallRules" ], - "description": "Lists all HorizonDb firewall rules in a pool.", + "description": "Lists all HorizonDB firewall rules in a pool.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -621,7 +621,7 @@ { "name": "clusterName", "in": "path", - "description": "The name of the HorizonDb cluster.", + "description": "The name of the HorizonDB cluster.", "required": true, "type": "string", "minLength": 1, @@ -631,7 +631,7 @@ { "name": "poolName", "in": "path", - "description": "The name of the HorizonDb pool.", + "description": "The name of the HorizonDB pool.", "required": true, "type": "string", "minLength": 1, @@ -654,7 +654,7 @@ } }, "x-ms-examples": { - "List HorizonDb firewall rules in a pool": { + "List HorizonDB firewall rules in a pool": { "$ref": "./examples/FirewallRules_List.json" } }, @@ -669,7 +669,7 @@ "tags": [ "HorizonDbFirewallRules" ], - "description": "Gets information about a HorizonDb firewall rule.", + "description": "Gets information about a HorizonDB firewall rule.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -683,7 +683,7 @@ { "name": "clusterName", "in": "path", - "description": "The name of the HorizonDb cluster.", + "description": "The name of the HorizonDB cluster.", "required": true, "type": "string", "minLength": 1, @@ -693,7 +693,7 @@ { "name": "poolName", "in": "path", - "description": "The name of the HorizonDb pool.", + "description": "The name of the HorizonDB pool.", "required": true, "type": "string", "minLength": 1, @@ -703,7 +703,7 @@ { "name": "firewallRuleName", "in": "path", - "description": "The name of the HorizonDb firewall rule.", + "description": "The name of the HorizonDB firewall rule.", "required": true, "type": "string", "minLength": 1, @@ -726,7 +726,7 @@ } }, "x-ms-examples": { - "Get a HorizonDb firewall rule": { + "Get a HorizonDB firewall rule": { "$ref": "./examples/FirewallRules_Get.json" } } @@ -736,7 +736,7 @@ "tags": [ "HorizonDbFirewallRules" ], - "description": "Creates a new HorizonDb firewall rule or updates an existing rule.", + "description": "Creates a new HorizonDB firewall rule or updates an existing rule.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -750,7 +750,7 @@ { "name": "clusterName", "in": "path", - "description": "The name of the HorizonDb cluster.", + "description": "The name of the HorizonDB cluster.", "required": true, "type": "string", "minLength": 1, @@ -760,7 +760,7 @@ { "name": "poolName", "in": "path", - "description": "The name of the HorizonDb pool.", + "description": "The name of the HorizonDB pool.", "required": true, "type": "string", "minLength": 1, @@ -770,7 +770,7 @@ { "name": "firewallRuleName", "in": "path", - "description": "The name of the HorizonDb firewall rule.", + "description": "The name of the HorizonDB firewall rule.", "required": true, "type": "string", "minLength": 1, @@ -819,7 +819,7 @@ } }, "x-ms-examples": { - "Create or update a HorizonDb firewall rule": { + "Create or update a HorizonDB firewall rule": { "$ref": "./examples/FirewallRules_CreateOrUpdate.json" } }, @@ -834,7 +834,7 @@ "tags": [ "HorizonDbFirewallRules" ], - "description": "Deletes a HorizonDb firewall rule.", + "description": "Deletes a HorizonDB firewall rule.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -848,7 +848,7 @@ { "name": "clusterName", "in": "path", - "description": "The name of the HorizonDb cluster.", + "description": "The name of the HorizonDB cluster.", "required": true, "type": "string", "minLength": 1, @@ -858,7 +858,7 @@ { "name": "poolName", "in": "path", - "description": "The name of the HorizonDb pool.", + "description": "The name of the HorizonDB pool.", "required": true, "type": "string", "minLength": 1, @@ -868,7 +868,7 @@ { "name": "firewallRuleName", "in": "path", - "description": "The name of the HorizonDb firewall rule.", + "description": "The name of the HorizonDB firewall rule.", "required": true, "type": "string", "minLength": 1, @@ -907,7 +907,7 @@ } }, "x-ms-examples": { - "Delete a HorizonDb firewall rule": { + "Delete a HorizonDB firewall rule": { "$ref": "./examples/FirewallRules_Delete.json" } }, @@ -923,7 +923,7 @@ "tags": [ "HorizonDbReplicas" ], - "description": "Lists all HorizonDb replicas in a pool.", + "description": "Lists all HorizonDB replicas in a pool.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -937,7 +937,7 @@ { "name": "clusterName", "in": "path", - "description": "The name of the HorizonDb cluster.", + "description": "The name of the HorizonDB cluster.", "required": true, "type": "string", "minLength": 1, @@ -947,7 +947,7 @@ { "name": "poolName", "in": "path", - "description": "The name of the HorizonDb pool.", + "description": "The name of the HorizonDB pool.", "required": true, "type": "string", "minLength": 1, @@ -970,7 +970,7 @@ } }, "x-ms-examples": { - "List HorizonDb replicas in a pool": { + "List HorizonDB replicas in a pool": { "$ref": "./examples/Replicas_List.json" } }, @@ -985,7 +985,7 @@ "tags": [ "HorizonDbReplicas" ], - "description": "Gets information about a HorizonDb replica.", + "description": "Gets information about a HorizonDB replica.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -999,7 +999,7 @@ { "name": "clusterName", "in": "path", - "description": "The name of the HorizonDb cluster.", + "description": "The name of the HorizonDB cluster.", "required": true, "type": "string", "minLength": 1, @@ -1009,7 +1009,7 @@ { "name": "poolName", "in": "path", - "description": "The name of the HorizonDb pool.", + "description": "The name of the HorizonDB pool.", "required": true, "type": "string", "minLength": 1, @@ -1019,7 +1019,7 @@ { "name": "replicaName", "in": "path", - "description": "The name of the HorizonDb replica.", + "description": "The name of the HorizonDB replica.", "required": true, "type": "string", "minLength": 1, @@ -1042,7 +1042,7 @@ } }, "x-ms-examples": { - "Get a HorizonDb replica": { + "Get a HorizonDB replica": { "$ref": "./examples/Replicas_Get.json" } } @@ -1052,7 +1052,7 @@ "tags": [ "HorizonDbReplicas" ], - "description": "Creates a new HorizonDb replica or updates an existing replica.", + "description": "Creates a new HorizonDB replica or updates an existing replica.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -1066,7 +1066,7 @@ { "name": "clusterName", "in": "path", - "description": "The name of the HorizonDb cluster.", + "description": "The name of the HorizonDB cluster.", "required": true, "type": "string", "minLength": 1, @@ -1076,7 +1076,7 @@ { "name": "poolName", "in": "path", - "description": "The name of the HorizonDb pool.", + "description": "The name of the HorizonDB pool.", "required": true, "type": "string", "minLength": 1, @@ -1086,7 +1086,7 @@ { "name": "replicaName", "in": "path", - "description": "The name of the HorizonDb replica.", + "description": "The name of the HorizonDB replica.", "required": true, "type": "string", "minLength": 1, @@ -1135,7 +1135,7 @@ } }, "x-ms-examples": { - "Create or update a HorizonDb replica": { + "Create or update a HorizonDB replica": { "$ref": "./examples/Replicas_CreateOrUpdate.json" } }, @@ -1150,7 +1150,7 @@ "tags": [ "HorizonDbReplicas" ], - "description": "Updates an existing HorizonDb replica (e.g., role).", + "description": "Updates an existing HorizonDB replica (e.g., role).", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -1164,7 +1164,7 @@ { "name": "clusterName", "in": "path", - "description": "The name of the HorizonDb cluster.", + "description": "The name of the HorizonDB cluster.", "required": true, "type": "string", "minLength": 1, @@ -1174,7 +1174,7 @@ { "name": "poolName", "in": "path", - "description": "The name of the HorizonDb pool.", + "description": "The name of the HorizonDB pool.", "required": true, "type": "string", "minLength": 1, @@ -1184,7 +1184,7 @@ { "name": "replicaName", "in": "path", - "description": "The name of the HorizonDb replica.", + "description": "The name of the HorizonDB replica.", "required": true, "type": "string", "minLength": 1, @@ -1230,7 +1230,7 @@ } }, "x-ms-examples": { - "Update a HorizonDb replica": { + "Update a HorizonDB replica": { "$ref": "./examples/Replicas_Update.json" } }, @@ -1245,7 +1245,7 @@ "tags": [ "HorizonDbReplicas" ], - "description": "Deletes a HorizonDb replica.", + "description": "Deletes a HorizonDB replica.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -1259,7 +1259,7 @@ { "name": "clusterName", "in": "path", - "description": "The name of the HorizonDb cluster.", + "description": "The name of the HorizonDB cluster.", "required": true, "type": "string", "minLength": 1, @@ -1269,7 +1269,7 @@ { "name": "poolName", "in": "path", - "description": "The name of the HorizonDb pool.", + "description": "The name of the HorizonDB pool.", "required": true, "type": "string", "minLength": 1, @@ -1279,7 +1279,7 @@ { "name": "replicaName", "in": "path", - "description": "The name of the HorizonDb replica.", + "description": "The name of the HorizonDB replica.", "required": true, "type": "string", "minLength": 1, @@ -1318,7 +1318,7 @@ } }, "x-ms-examples": { - "Delete a HorizonDb replica": { + "Delete a HorizonDB replica": { "$ref": "./examples/Replicas_Delete.json" } }, @@ -1334,7 +1334,7 @@ "tags": [ "HorizonDbPrivateEndpointConnections" ], - "description": "Lists private endpoint connections in a HorizonDb cluster.", + "description": "Lists private endpoint connections in a HorizonDB cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -1348,7 +1348,7 @@ { "name": "clusterName", "in": "path", - "description": "The name of the HorizonDb cluster.", + "description": "The name of the HorizonDB cluster.", "required": true, "type": "string", "minLength": 1, @@ -1400,7 +1400,7 @@ { "name": "clusterName", "in": "path", - "description": "The name of the HorizonDb cluster.", + "description": "The name of the HorizonDB cluster.", "required": true, "type": "string", "minLength": 1, @@ -1438,7 +1438,7 @@ "tags": [ "HorizonDbPrivateLinkResources" ], - "description": "Lists private link resources in a HorizonDb cluster.", + "description": "Lists private link resources in a HorizonDB cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -1452,7 +1452,7 @@ { "name": "clusterName", "in": "path", - "description": "The name of the HorizonDb cluster.", + "description": "The name of the HorizonDB cluster.", "required": true, "type": "string", "minLength": 1, @@ -1475,7 +1475,7 @@ } }, "x-ms-examples": { - "Gets private link resources for HorizonDb": { + "Gets private link resources for HorizonDB": { "$ref": "./examples/PrivateLinkResources_List.json" } }, @@ -1504,7 +1504,7 @@ { "name": "clusterName", "in": "path", - "description": "The name of the HorizonDb cluster.", + "description": "The name of the HorizonDB cluster.", "required": true, "type": "string", "minLength": 1, @@ -1537,7 +1537,7 @@ } }, "x-ms-examples": { - "Gets a private link resource for HorizonDb": { + "Gets a private link resource for HorizonDB": { "$ref": "./examples/PrivateLinkResources_Get.json" } } @@ -1549,7 +1549,7 @@ "tags": [ "HorizonDbParameterGroups" ], - "description": "Lists all HorizonDb parameter groups in a resource group.", + "description": "Lists all HorizonDB parameter groups in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -1576,7 +1576,7 @@ } }, "x-ms-examples": { - "List HorizonDb parameter groups in a resource group": { + "List HorizonDB parameter groups in a resource group": { "$ref": "./examples/ParameterGroups_ListByResourceGroup.json" } }, @@ -1591,7 +1591,7 @@ "tags": [ "HorizonDbParameterGroups" ], - "description": "Gets information about a HorizonDb parameter group.", + "description": "Gets information about a HorizonDB parameter group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -1605,7 +1605,7 @@ { "name": "parameterGroupName", "in": "path", - "description": "The name of the HorizonDb parameter group.", + "description": "The name of the HorizonDB parameter group.", "required": true, "type": "string", "minLength": 1, @@ -1628,7 +1628,7 @@ } }, "x-ms-examples": { - "Get a HorizonDb parameter group": { + "Get a HorizonDB parameter group": { "$ref": "./examples/ParameterGroups_Get.json" } } @@ -1638,7 +1638,7 @@ "tags": [ "HorizonDbParameterGroups" ], - "description": "Creates a new HorizonDb parameter group or updates an existing parameter group.", + "description": "Creates a new HorizonDB parameter group or updates an existing parameter group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -1652,7 +1652,7 @@ { "name": "parameterGroupName", "in": "path", - "description": "The name of the HorizonDb parameter group.", + "description": "The name of the HorizonDB parameter group.", "required": true, "type": "string", "minLength": 1, @@ -1701,7 +1701,7 @@ } }, "x-ms-examples": { - "Create or update a HorizonDb parameter group": { + "Create or update a HorizonDB parameter group": { "$ref": "./examples/ParameterGroups_CreateOrUpdate.json" } }, @@ -1716,7 +1716,7 @@ "tags": [ "HorizonDbParameterGroups" ], - "description": "Updates an existing HorizonDb parameter group.", + "description": "Updates an existing HorizonDB parameter group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -1730,7 +1730,7 @@ { "name": "parameterGroupName", "in": "path", - "description": "The name of the HorizonDb parameter group.", + "description": "The name of the HorizonDB parameter group.", "required": true, "type": "string", "minLength": 1, @@ -1776,7 +1776,7 @@ } }, "x-ms-examples": { - "Update a HorizonDb parameter group": { + "Update a HorizonDB parameter group": { "$ref": "./examples/ParameterGroups_Update.json" } }, @@ -1791,7 +1791,7 @@ "tags": [ "HorizonDbParameterGroups" ], - "description": "Deletes a HorizonDb parameter group.", + "description": "Deletes a HorizonDB parameter group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -1805,7 +1805,7 @@ { "name": "parameterGroupName", "in": "path", - "description": "The name of the HorizonDb parameter group.", + "description": "The name of the HorizonDB parameter group.", "required": true, "type": "string", "minLength": 1, @@ -1844,7 +1844,7 @@ } }, "x-ms-examples": { - "Delete a HorizonDb parameter group": { + "Delete a HorizonDB parameter group": { "$ref": "./examples/ParameterGroups_Delete.json" } }, @@ -1874,7 +1874,7 @@ { "name": "parameterGroupName", "in": "path", - "description": "The name of the HorizonDb parameter group.", + "description": "The name of the HorizonDB parameter group.", "required": true, "type": "string", "minLength": 1, @@ -1897,7 +1897,7 @@ } }, "x-ms-examples": { - "List connections for a HorizonDb parameter group": { + "List connections for a HorizonDB parameter group": { "$ref": "./examples/ParameterGroups_ListConnections.json" } }, @@ -1926,7 +1926,7 @@ { "name": "parameterGroupName", "in": "path", - "description": "The name of the HorizonDb parameter group.", + "description": "The name of the HorizonDB parameter group.", "required": true, "type": "string", "minLength": 1, @@ -2124,7 +2124,7 @@ }, "CreateModeCluster": { "type": "string", - "description": "The mode to create a new HorizonDb cluster.", + "description": "The mode to create a new HorizonDB cluster.", "enum": [ "Create", "Update", @@ -2154,7 +2154,7 @@ }, "CreateModePool": { "type": "string", - "description": "The mode to create a new HorizonDb cluster.", + "description": "The mode to create a new HorizonDB cluster.", "enum": [ "Create", "Update" @@ -2178,7 +2178,7 @@ }, "HorizonDbCluster": { "type": "object", - "description": "Represents the HorizonDb cluster.", + "description": "Represents the HorizonDB cluster.", "properties": { "properties": { "$ref": "#/definitions/HorizonDbClusterProperties", @@ -2193,7 +2193,7 @@ }, "HorizonDbClusterForPatchUpdate": { "type": "object", - "description": "HorizonDb cluster for update operations.", + "description": "HorizonDB cluster for update operations.", "properties": { "tags": { "type": "object", @@ -2204,7 +2204,7 @@ }, "properties": { "$ref": "#/definitions/HorizonDbClusterPropertiesForPatchUpdate", - "description": "The properties that can be updated for a HorizonDb cluster." + "description": "The properties that can be updated for a HorizonDB cluster." } } }, @@ -2231,7 +2231,7 @@ }, "HorizonDbClusterParameterGroupConnectionProperties": { "type": "object", - "description": "Connection information for HorizonDb parameter group.", + "description": "Connection information for HorizonDB parameter group.", "properties": { "id": { "type": "string", @@ -2244,7 +2244,7 @@ }, "syncStatus": { "type": "string", - "description": "Indication of if parameter group is applied on HorizonDb resource.", + "description": "Indication of if parameter group is applied on HorizonDB resource.", "readOnly": true }, "applyImmediately": { @@ -2259,7 +2259,7 @@ }, "HorizonDbClusterProperties": { "type": "object", - "description": "Properties of a HorizonDb cluster.", + "description": "Properties of a HorizonDB cluster.", "properties": { "administratorLogin": { "type": "string", @@ -2285,11 +2285,11 @@ }, "version": { "type": "string", - "description": "The version of the HorizonDb cluster." + "description": "The version of the HorizonDB cluster." }, "createMode": { "$ref": "#/definitions/CreateModeCluster", - "description": "The mode to create a new HorizonDb cluster." + "description": "The mode to create a new HorizonDB cluster." }, "pointInTimeUTC": { "type": "string", @@ -2329,7 +2329,7 @@ }, "processorType": { "type": "string", - "description": "The processor type for the HorizonDb cluster." + "description": "The processor type for the HorizonDB cluster." }, "network": { "$ref": "#/definitions/Network", @@ -2378,7 +2378,7 @@ }, "HorizonDbClusterPropertiesForPatchUpdate": { "type": "object", - "description": "Properties of a HorizonDb cluster for update operations.", + "description": "Properties of a HorizonDB cluster for update operations.", "properties": { "administratorLoginPassword": { "type": "string", @@ -2409,7 +2409,7 @@ }, "HorizonDbFirewallRule": { "type": "object", - "description": "Represents the HorizonDb firewall rule.", + "description": "Represents the HorizonDB firewall rule.", "properties": { "properties": { "$ref": "#/definitions/HorizonDbFirewallRuleProperties", @@ -2445,7 +2445,7 @@ }, "HorizonDbFirewallRuleProperties": { "type": "object", - "description": "Properties of a HorizonDb firewall rule.", + "description": "Properties of a HorizonDB firewall rule.", "properties": { "startIpAddress": { "type": "string", @@ -2467,7 +2467,7 @@ }, "description": { "type": "string", - "description": "The description of the HorizonDb firewall rule.", + "description": "The description of the HorizonDB firewall rule.", "x-ms-mutability": [ "read", "update", @@ -2487,7 +2487,7 @@ }, "HorizonDbParameterGroup": { "type": "object", - "description": "Represents the HorizonDb parameter group.", + "description": "Represents the HorizonDB parameter group.", "properties": { "properties": { "$ref": "#/definitions/HorizonDbParameterGroupProperties", @@ -2502,7 +2502,7 @@ }, "HorizonDbParameterGroupConnectionProperties": { "type": "object", - "description": "Connection information for HorizonDb parameter group.", + "description": "Connection information for HorizonDB parameter group.", "properties": { "name": { "type": "string", @@ -2545,7 +2545,7 @@ }, "HorizonDbParameterGroupForPatchUpdate": { "type": "object", - "description": "HorizonDb parameter group for update operations.", + "description": "HorizonDB parameter group for update operations.", "properties": { "tags": { "type": "object", @@ -2556,7 +2556,7 @@ }, "properties": { "$ref": "#/definitions/HorizonDbParameterGroupPropertiesForPatchUpdate", - "description": "The properties that can be updated for a HorizonDb parameter group." + "description": "The properties that can be updated for a HorizonDB parameter group." } } }, @@ -2583,7 +2583,7 @@ }, "HorizonDbParameterGroupProperties": { "type": "object", - "description": "Properties of a HorizonDb parameter group.", + "description": "Properties of a HorizonDB parameter group.", "properties": { "parameters": { "type": "array", @@ -2642,7 +2642,7 @@ }, "HorizonDbParameterGroupPropertiesForPatchUpdate": { "type": "object", - "description": "Properties of a HorizonDb parameter group for update operations.", + "description": "Properties of a HorizonDB parameter group for update operations.", "properties": { "parameters": { "type": "array", @@ -2675,7 +2675,7 @@ }, "HorizonDbPool": { "type": "object", - "description": "Represents the HorizonDb pool.", + "description": "Represents the HorizonDB pool.", "properties": { "properties": { "$ref": "#/definitions/HorizonDbPoolProperties", @@ -2718,11 +2718,11 @@ }, "HorizonDbPoolProperties": { "type": "object", - "description": "Properties of a HorizonDb pool.", + "description": "Properties of a HorizonDB pool.", "properties": { "location": { "$ref": "#/definitions/Azure.Core.azureLocation", - "description": "The location of the HorizonDb pool.", + "description": "The location of the HorizonDB pool.", "x-ms-mutability": [ "read", "create" @@ -2741,7 +2741,7 @@ }, "version": { "type": "string", - "description": "The version of the HorizonDb pool.", + "description": "The version of the HorizonDB pool.", "readOnly": true }, "createMode": { @@ -2758,7 +2758,7 @@ }, "HorizonDbPrivateLinkResource": { "type": "object", - "description": "Represents the HorizonDb private link resource.", + "description": "Represents the HorizonDB private link resource.", "properties": { "properties": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateLinkResourceProperties", @@ -2794,7 +2794,7 @@ }, "HorizonDbReplica": { "type": "object", - "description": "Represents the HorizonDb replica.", + "description": "Represents the HorizonDB replica.", "properties": { "properties": { "$ref": "#/definitions/HorizonDbReplicaProperties", @@ -2809,11 +2809,11 @@ }, "HorizonDbReplicaForPatchUpdate": { "type": "object", - "description": "HorizonDb replica for update operations.", + "description": "HorizonDB replica for update operations.", "properties": { "properties": { "$ref": "#/definitions/HorizonDbReplicaPropertiesForPatchUpdate", - "description": "Properties of a HorizonDb replica for update operations." + "description": "Properties of a HorizonDB replica for update operations." } } }, @@ -2840,7 +2840,7 @@ }, "HorizonDbReplicaProperties": { "type": "object", - "description": "Properties of a HorizonDb replica.", + "description": "Properties of a HorizonDB replica.", "properties": { "role": { "$ref": "#/definitions/ReplicaRole", @@ -2874,7 +2874,7 @@ }, "HorizonDbReplicaPropertiesForPatchUpdate": { "type": "object", - "description": "Properties of a HorizonDb replica for update operations.", + "description": "Properties of a HorizonDB replica for update operations.", "properties": { "role": { "$ref": "#/definitions/ReplicaRole", @@ -2898,7 +2898,7 @@ }, "ParameterProperties": { "type": "object", - "description": "Properties of a HorizonDb parameters.", + "description": "Properties of a HorizonDB parameters.", "properties": { "name": { "type": "string", diff --git a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/routes.tsp b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/routes.tsp index 8f31b895a060..e77395d6feaf 100644 --- a/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/routes.tsp +++ b/specification/horizondb/resource-manager/Microsoft.HorizonDb/HorizonDb/routes.tsp @@ -13,20 +13,20 @@ alias HorizonDbPrivateEndpointOperations = Azure.ResourceManager.PrivateEndpoint @armResourceOperations interface HorizonDbClusters { - @doc("Gets information about a HorizonDb cluster.") + @doc("Gets information about a HorizonDB cluster.") get is ArmResourceRead; - @doc("Creates a new HorizonDb cluster or updates an existing cluster.") + @doc("Creates a new HorizonDB cluster or updates an existing cluster.") @Azure.Core.useFinalStateVia("azure-async-operation") createOrUpdate is ArmResourceCreateOrReplaceAsync; - @doc("Updates an existing HorizonDb cluster (e.g., tags, virtual cores, replica count).") + @doc("Updates an existing HorizonDB cluster (e.g., tags, virtual cores, replica count).") update is ArmCustomPatchAsync< HorizonDbCluster, HorizonDbClusterForPatchUpdate >; - @doc("Deletes a HorizonDb cluster.") + @doc("Deletes a HorizonDB cluster.") delete is ArmResourceDeleteWithoutOkAsync< HorizonDbCluster, Response = @@ -35,41 +35,41 @@ interface HorizonDbClusters { | ArmDeletedNoContentResponse >; - @doc("Lists all HorizonDb clusters in a resource group.") + @doc("Lists all HorizonDB clusters in a resource group.") listByResourceGroup is ArmResourceListByParent; - @doc("Lists all HorizonDb clusters in a subscription.") + @doc("Lists all HorizonDB clusters in a subscription.") listBySubscription is ArmListBySubscription; } @armResourceOperations interface HorizonDbPools { - @doc("Gets information about a HorizonDb pool.") + @doc("Gets information about a HorizonDB pool.") get is ArmResourceRead; - @doc("Lists all HorizonDb pools in a cluster.") + @doc("Lists all HorizonDB pools in a cluster.") list is ArmResourceListByParent; } @armResourceOperations interface HorizonDbReplicas { - @doc("Gets information about a HorizonDb replica.") + @doc("Gets information about a HorizonDB replica.") get is ArmResourceRead; - @doc("Lists all HorizonDb replicas in a pool.") + @doc("Lists all HorizonDB replicas in a pool.") list is ArmResourceListByParent; - @doc("Creates a new HorizonDb replica or updates an existing replica.") + @doc("Creates a new HorizonDB replica or updates an existing replica.") @Azure.Core.useFinalStateVia("azure-async-operation") createOrUpdate is ArmResourceCreateOrReplaceAsync; - @doc("Updates an existing HorizonDb replica (e.g., role).") + @doc("Updates an existing HorizonDB replica (e.g., role).") update is ArmCustomPatchAsync< HorizonDbReplica, HorizonDbReplicaForPatchUpdate >; - @doc("Deletes a HorizonDb replica.") + @doc("Deletes a HorizonDB replica.") delete is ArmResourceDeleteWithoutOkAsync< HorizonDbReplica, Response = @@ -81,17 +81,17 @@ interface HorizonDbReplicas { @armResourceOperations interface HorizonDbFirewallRules { - @doc("Gets information about a HorizonDb firewall rule.") + @doc("Gets information about a HorizonDB firewall rule.") get is ArmResourceRead; - @doc("Lists all HorizonDb firewall rules in a pool.") + @doc("Lists all HorizonDB firewall rules in a pool.") list is ArmResourceListByParent; - @doc("Creates a new HorizonDb firewall rule or updates an existing rule.") + @doc("Creates a new HorizonDB firewall rule or updates an existing rule.") @Azure.Core.useFinalStateVia("azure-async-operation") createOrUpdate is ArmResourceCreateOrReplaceAsync; - @doc("Deletes a HorizonDb firewall rule.") + @doc("Deletes a HorizonDB firewall rule.") delete is ArmResourceDeleteWithoutOkAsync< HorizonDbFirewallRule, Response = @@ -109,7 +109,7 @@ interface HorizonDbPrivateEndpointConnections { PrivateEndpointConnectionResource >; - @doc("Lists private endpoint connections in a HorizonDb cluster.") + @doc("Lists private endpoint connections in a HorizonDB cluster.") list is HorizonDbPrivateEndpointOperations.ListByParent< HorizonDbCluster, PrivateEndpointConnectionResource @@ -133,26 +133,26 @@ interface HorizonDbPrivateLinkResources { @doc("Gets a private link resource.") get is ArmResourceRead; - @doc("Lists private link resources in a HorizonDb cluster.") + @doc("Lists private link resources in a HorizonDB cluster.") list is ArmResourceListByParent; } @armResourceOperations interface HorizonDbParameterGroups { - @doc("Gets information about a HorizonDb parameter group.") + @doc("Gets information about a HorizonDB parameter group.") get is ArmResourceRead; - @doc("Creates a new HorizonDb parameter group or updates an existing parameter group.") + @doc("Creates a new HorizonDB parameter group or updates an existing parameter group.") @Azure.Core.useFinalStateVia("azure-async-operation") createOrUpdate is ArmResourceCreateOrReplaceAsync; - @doc("Updates an existing HorizonDb parameter group.") + @doc("Updates an existing HorizonDB parameter group.") update is ArmCustomPatchAsync< HorizonDbParameterGroup, HorizonDbParameterGroupForPatchUpdate >; - @doc("Deletes a HorizonDb parameter group.") + @doc("Deletes a HorizonDB parameter group.") delete is ArmResourceDeleteWithoutOkAsync< HorizonDbParameterGroup, Response = @@ -161,10 +161,10 @@ interface HorizonDbParameterGroups { | ArmDeletedNoContentResponse >; - @doc("Lists all HorizonDb parameter groups in a resource group.") + @doc("Lists all HorizonDB parameter groups in a resource group.") listByResourceGroup is ArmResourceListByParent; - @doc("Lists all HorizonDb parameter groups in a subscription.") + @doc("Lists all HorizonDB parameter groups in a subscription.") listBySubscription is ArmListBySubscription; @doc("Gets all connections to a parameter group.") diff --git a/specification/horizondb/resource-manager/readme.md b/specification/horizondb/resource-manager/readme.md index c310da0553b1..6b7c109c3880 100644 --- a/specification/horizondb/resource-manager/readme.md +++ b/specification/horizondb/resource-manager/readme.md @@ -1,4 +1,4 @@ -# HorizonDb +# HorizonDB > see https://aka.ms/autorest > This is the AutoRest configuration file for HorizonDb. From 0f5256fb89e8d2b6677fa32aa8a2e76be23d2e30 Mon Sep 17 00:00:00 2001 From: fmabroukmsft <134638798+fmabroukmsft@users.noreply.github.com> Date: Tue, 2 Jun 2026 09:58:32 -0700 Subject: [PATCH 08/22] Add CognitiveServices stable API version 2026-05-01 (#42549) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add CognitiveServices stable API version 2026-03-01 - Add v2026_03_01 to version enum in main.tsp - Copy TypeSpec examples from 2026-01-15-preview, update api-version - Compile TypeSpec to generate cognitiveservices.json (88 paths, 290 defs) - Generated RM examples (160 files, all referenced, zero orphans) - Update readme.md: default tag to package-2026-03-01, add tag section - Single-track versioning: all preview features promoted to stable - New vs prev stable: +1 path (ComputeOperations), +6 definitions * Gate preview-only features from 2026-03-01 stable with @removed decorators Add @removed(Versions.v2026_03_01) to 13 features first introduced in 2026-01-15-preview that should remain preview-only: ComputeOperation.tsp (4): ComputeOperationStatus model, ComputeOperations interface, ComputeOperationStatusProperties model, ComputeOperationStatusType union ManagedNetworkSettingsPropertiesBasicResource.tsp (1): delete operation models.tsp (8): QuotaScopeType union, foundryAutoUpgrade property, FoundryAutoUpgradeMode union, FoundryAutoUpgrade model, scopeType/scopeId on Usage, scopeId/scopeType on ModelSkuCapacityProperties Cascading changes: - Remove 14 TypeSpec examples (2 removed ops + 12 scope-variants) - Remove 14 RM examples (matching orphaned references) - Clean scopeType/scopeId from 4 base examples - Remove NestedResourcesMustHaveListOperation suppression - Recompile: 87 paths, 284 defs (down from 88/290) * Add CognitiveServices preview API version 2026-03-15-preview swagger Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Recompile 2026-03-15-preview swagger after customTopics removal Merge main to pick up @removed(Versions.v2025_10_01_preview) decorators for customTopics, CustomTopicConfig, and RaiTopicConfig from PR #42012. Recompile to remove these definitions from 2026-03-15-preview output. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * add accelerator usages API details * add changes as per PR * accelerator usage api changes * add accelerator change * add format for subs id * Revert AcceleratorUsages API changes from PR #42466 (#42469) Reverts commits 9bd196e..0cca7e2 which added AcceleratorUsages operation and models directly to swagger JSON. These changes need to be re-added properly via TypeSpec source files. * Users/chunyli/cogsvc managed compute deployment (#42130) * Add ManagedCompute deployment API * mark model as non-required * fix gated error * fix unknown word * Add example * check in generated examples * update spec * fix lint * resolve comments * resolve comments * resolve comments * resolve comments * fix lint * fix lint * fix format * resolve comments * switch from AcceleratorDeployment to ManagedComputeDeployment * update suppresion * resolve comments * Add CognitiveServices stable API version 2026-05-01 TypeSpec enum, compiled cognitiveservices.json, examples, readme.md tag section. Feature gating: 13 existing @removed/@added pairs extended to triplets, 7 new @removed(v2026_05_01) for ManagedComputeDeployment + PatchResourceSku (kept preview-only per user decision). 7 orphaned examples cleaned. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Regenerate stable/2026-05-01 with TSP 1.12 + Phase 3 QuotaScopeType cleanup Phase 2: Regenerated cognitiveservices.json from merged TypeSpec source using @typespec/compiler 1.12.0. Picks up changes from interim PRs: - VmManagedCompute deployment shape (#43238) — computeId, priority, deploymentTemplate type - New compute surface: Compute, ManagedComputeCapacity, ContainerInstance, ComputeProvisioningState (#42324, #42642, #42794) - Model-Router enum correction accuracy->quality (#42375) - x-ms-pageable on batchOutboundRules POST (#42435) - RaiExternalSafetyProvider 201 response fix (#42414) - DELETE managedNetworks promotion to stable (#42585) — restores GA operation that was incorrectly gated out of stable/2026-05-01 by the swagger-agent's lone-@removed fallback bug Regression audit vs previous stable (2026-03-01): 0 operation regressions, 0 definition regressions, 0 property regressions, 0 enum value regressions. 19 new operations and 29 new definitions added — all need GA feature-confirmation with owners in a follow-up step. Phase 3: QuotaScopeType example cleanup. The TSP recompile already deleted the 12 orphan scope-variant files automatically. Stripped remaining scopeType/scopeId properties from the 4 base example response bodies in both TSP source and RM output: - GetUsages.json, ListUsages.json - ListModelCapacities.json, ListLocationBasedModelCapacities.json This resolves the 26 OBJECT_ADDITIONAL_PROPERTIES Swagger ModelValidation errors. Verification: - All 138 RM example files referenced by x-ms-examples (0 orphans) - All 138 TSP source examples referenced by x-ms-examples (0 orphans) - Zero scopeType/scopeId occurrences in any base example file Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Phase 3 fix: delete 12 QuotaScopeType scope-variant example files Previous Phase 3 attempt only stripped scopeType/scopeId from base example response bodies but left the 12 scope-variant example files in the TSP source examples/2026-05-01/ directory. The TypeSpec compiler auto-discovers any .json file in the version examples directory by its operationId field and emits x-ms-examples references, causing the files to be copied to RM output and validated against the schema. Since QuotaScopeType is gated out of stable/2026-05-01, the response bodies in these examples contain properties not allowed by the schema, causing 26 OBJECT_ADDITIONAL_PROPERTIES Swagger ModelValidation errors. Deleted from TSP source (compiler-managed copy to RM output handled by clean rebuild): - GetUsages{Classic,DataZone,Global}Scope.json - ListUsages{Classic,DataZone,Global}Scope.json - ListModelCapacities{Classic,DataZone,Global}Scope.json - ListLocationBasedModelCapacities{Classic,DataZone,Global}Scope.json After clean rebuild of stable/2026-05-01 RM directory: zero scope- variant references in compiled swagger, zero scopeType/scopeId in remaining base examples. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Sync new stable suppressions block with previous preview The swagger-agent skill (sub-skill-swagger.md Step 7) directs new tag sections to copy the previous tag of the same TRACK (stable->stable, preview->preview). For CognitiveServices this is inconsistent with its own content-flow rule: CogSvc is single-track, so new stable inherits content from previous preview. The result was that new stable 2026-05-01 inherited preview content (Compute, Workbench, ManagedCompute*, EvaluateDeploymentPolicies, additional PATCH/DELETE paths) but only the previous-stable suppression block (17 entries), dropping 4 net new codes and several path extensions added in preview. This commit replaces the new stable's suppressions block with the previous preview's block (21 entries). Manual diff confirmed the preview block is a strict superset in path coverage with no entries unique to the previous stable — every 'stable-only' entry has a matching preview entry with broader 'where:' lists or more detailed 'reason:' text. Net effect: - +NestedResourcesMustHaveListOperation (ComputeOperationStatus) - +RequiredPropertiesMissingInResourceModel (ManagedComputeUsageListResult) - +AvoidAdditionalProperties (EvaluateDeploymentPoliciesResponse.results) - +PatchBodyParametersSchema for Workbench - PatchBodyParametersSchema 'where' extended (+4 paths: managedComputeDeployments, computes, computes.computeType, computes.schema) - DeleteResponseCodes 'where' extended (+managedComputeDeployments) - More-detailed reasons on ProvisioningStateSpecifiedForLROPut and 2x AvoidAdditionalProperties Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add missing example files for ops inherited from preview via merge After the main merge brought new operations into the new stable (Computes_*, Workbenches_*, ManagedComputeUsagesOperationGroup_List, ManagedComputeCapacities_List, Accounts_EvaluateDeploymentPolicies, plus restored ManagedNetworkSettings_Delete and Projects_Delete from prior commit), 20 operations had no x-ms-examples in the compiled stable swagger, triggering 22 XMS_EXAMPLE_NOTFOUND_ERROR violations in Swagger ModelValidation. The TypeSpec compiler auto-discovers example files in the version's examples// directory by matching the file's operationId field. Example files for these operations existed in examples/2026-03-15-preview/ but not in examples/2026-05-01/. Copied 22 example files from the preview version directory to the new stable version directory and updated their api-version field from 2026-03-15-preview to 2026-05-01: ListManagedComputeUsages, ListManagedComputeCapacities, ListComputes, GetCompute, GetContainerInstanceCompute, PutCompute, PutContainerInstanceCompute, UpdateCompute, DeleteCompute, RestartContainerInstanceCompute, StartContainerInstanceCompute, StopContainerInstanceCompute, EvaluateDeploymentPolicies, ListWorkbenches, GetWorkbench, PutWorkbench, UpdateWorkbench, DeleteWorkbench, RestartWorkbench, StartWorkbench, StopWorkbench, ManagedNetwork/deleteManagedNetworkV2 After clean rebuild: 0 operations missing examples in compiled swagger. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Gate preview-only features out of 2026-05-01 stable Per direction: features first introduced in 2026-03-15-preview should not graduate to stable in this cycle. The new stable 2026-05-01 should be content-identical to the previous stable 2026-03-01 (since the original PR (2026-04-21) had no new GA-approved additions beyond 2026-03-01, and all subsequent additions to preview during the 38-day PR lifespan are preview-only). Added @removed(Versions.v2026_05_01) decorators to 32 elements: models.tsp (26 entries): ClusterComputeProperties, ComputeListResult, ComputeProperties, ComputeProvisioningState, ComputeType, ConnectivityEndpoints, ContainerInstanceComputeProperties, DeploymentPolicyEvaluationResult, DeploymentSizeCapacity, EvaluateDeploymentPoliciesDeployment, EvaluateDeploymentPoliciesDeploymentProperties, EvaluateDeploymentPoliciesRequest, EvaluateDeploymentPoliciesResponse, ManagedComputeCapacityListResult, ManagedComputeCapacityProperties, ManagedComputeDeploymentInfo, ManagedComputeUsage, ManagedComputeUsageListResult, PolicyAssignmentEvaluationDetails, PolicyEvaluationOutcome, PolicyExpressionEvaluationDetails, Pool, SshSettings, VmPriority, WorkbenchListResult, WorkbenchProperties Compute.tsp: Compute model + Computes interface Workbench.tsp: Workbench model + Workbenches interface ManagedComputeCapacity.tsp: ManagedComputeCapacity model + ManagedComputeCapacities interface ManagedComputeUsages.tsp: ManagedComputeUsagesOperationGroup interface Account.tsp: evaluateDeploymentPolicies operation All decorators placed immediately after the existing @added(Versions.v2026_03_15_preview) per agent decorator-ordering rule. After clean rebuild: 2026-03-01 stable: 87 paths, 280 defs, 145 ops 2026-05-01 stable: 87 paths, 280 defs, 145 ops Delta ops/defs/paths: 0/0/0 — content-identical to 2026-03-01 Cleanup: - Deleted 21 example files for now-gated operations (Compute, Workbench, ManagedComputeCapacities, ManagedComputeUsages, EvaluateDeploymentPolicies) from both TSP source and RM output. Final example count: 127 = 127 refs. - Reverted readme.md package-2026-05-01 suppressions to the 17-entry set from package-2026-03-01 (the 21-entry preview set is no longer needed because the content those entries suppressed is gated out). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add missing 200 response to Projects_Delete example The Projects_Delete operation defines response codes 200, 202, 204, and default in the swagger spec, but the DeleteProject.json example only included 202 and 204. This caused Swagger ModelValidation error RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE for the 200 response code. The previous stable 2026-03-01's DeleteProject.json example does include 200 as an empty body response. Restored the 200 entry to match the 2026-03-01 example structure. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: abpatelmicrosoft Co-authored-by: Chunyu Li <79233053+ChunyuMSFT@users.noreply.github.com> Co-authored-by: Swagger Agent --- .../CognitiveServices.Management/Account.tsp | 1 + .../CognitiveServices.Management/Compute.tsp | 2 + .../ComputeOperation.tsp | 4 + .../ManagedComputeCapacity.tsp | 2 + .../ManagedComputeDeployment.tsp | 2 + .../ManagedComputeUsages.tsp | 1 + .../Workbench.tsp | 2 + .../AccountCapabilityHost/createOrUpdate.json | 55 + .../AccountCapabilityHost/delete.json | 19 + .../2026-05-01/AccountCapabilityHost/get.json | 30 + .../AccountCapabilityHost/list.json | 32 + .../2026-05-01/AccountConnection/create.json | 34 + .../2026-05-01/AccountConnection/delete.json | 15 + .../2026-05-01/AccountConnection/get.json | 26 + .../2026-05-01/AccountConnection/list.json | 41 + .../2026-05-01/AccountConnection/update.json | 41 + .../2026-05-01/AddRaiBlocklistItems.json | 38 + .../AgentApplication/createOrUpdate.json | 74 + .../2026-05-01/AgentApplication/delete.json | 21 + .../2026-05-01/AgentApplication/disable.json | 15 + .../2026-05-01/AgentApplication/enable.json | 15 + .../2026-05-01/AgentApplication/get.json | 38 + .../2026-05-01/AgentApplication/list.json | 51 + .../AgentApplication/listAgents.json | 56 + .../AgentDeployment/createOrUpdate.json | 109 + .../2026-05-01/AgentDeployment/delete.json | 22 + .../2026-05-01/AgentDeployment/get.json | 51 + .../2026-05-01/AgentDeployment/list.json | 54 + .../2026-05-01/AgentDeployment/start.json | 16 + .../2026-05-01/AgentDeployment/stop.json | 16 + .../2026-05-01/CalculateModelCapacity.json | 48 + .../2026-05-01/CheckDomainAvailability.json | 23 + .../2026-05-01/CheckSkuAvailability.json | 30 + .../examples/2026-05-01/CreateAccount.json | 142 + .../examples/2026-05-01/CreateAccountMin.json | 89 + .../2026-05-01/CreateOrUpdateQuotaTier.json | 40 + .../examples/2026-05-01/CreateProject.json | 98 + .../examples/2026-05-01/CreateProjectMin.json | 89 + .../CreateSharedCommitmentPlan.json | 69 + ...CreateSharedCommitmentPlanAssociation.json | 38 + .../examples/2026-05-01/DeleteAccount.json | 19 + .../2026-05-01/DeleteCommitmentPlan.json | 20 + .../examples/2026-05-01/DeleteDeployment.json | 20 + .../2026-05-01/DeleteEncryptionScope.json | 19 + .../DeletePrivateEndpointConnection.json | 21 + .../examples/2026-05-01/DeleteProject.json | 20 + .../2026-05-01/DeleteRaiBlocklist.json | 19 + .../2026-05-01/DeleteRaiBlocklistItem.json | 20 + .../2026-05-01/DeleteRaiBlocklistItems.json | 18 + .../DeleteRaiExternalSafetyProvider.json | 17 + .../examples/2026-05-01/DeleteRaiPolicy.json | 19 + .../2026-05-01/DeleteRaiToolLabel.json | 22 + .../examples/2026-05-01/DeleteRaiTopic.json | 19 + .../DeleteSharedCommitmentPlan.json | 19 + ...DeleteSharedCommitmentPlanAssociation.json | 20 + .../DeleteSubscriptionRaiPolicy.json | 19 + .../examples/2026-05-01/GetAccount.json | 33 + .../2026-05-01/GetCommitmentPlan.json | 28 + .../2026-05-01/GetDefenderForAISetting.json | 32 + .../2026-05-01/GetDeletedAccount.json | 34 + .../examples/2026-05-01/GetDeployment.json | 34 + .../2026-05-01/GetEncryptionScope.json | 40 + ...etworkSecurityPerimeterConfigurations.json | 48 + .../examples/2026-05-01/GetOperations.json | 45 + .../GetPrivateEndpointConnection.json | 31 + .../examples/2026-05-01/GetProject.json | 36 + .../examples/2026-05-01/GetQuotaTier.json | 28 + .../examples/2026-05-01/GetRaiBlocklist.json | 22 + .../2026-05-01/GetRaiBlocklistItem.json | 24 + .../2026-05-01/GetRaiContentFilter.json | 24 + .../GetRaiExternalSafetyProvider.json | 28 + .../examples/2026-05-01/GetRaiPolicy.json | 107 + .../examples/2026-05-01/GetRaiToolLabel.json | 44 + .../examples/2026-05-01/GetRaiTopic.json | 28 + .../2026-05-01/GetSharedCommitmentPlan.json | 33 + .../GetSharedCommitmentPlanAssociation.json | 23 + .../examples/2026-05-01/GetSkus.json | 2166 ++ .../2026-05-01/GetSubscriptionRaiPolicy.json | 107 + .../examples/2026-05-01/GetUsages.json | 30 + .../2026-05-01/ListAccountModels.json | 189 + .../ListAccountsByResourceGroup.json | 52 + .../ListAccountsBySubscription.json | 79 + .../2026-05-01/ListBlocklistItems.json | 35 + .../examples/2026-05-01/ListBlocklists.json | 25 + .../2026-05-01/ListCommitmentPlans.json | 31 + .../2026-05-01/ListCommitmentTiers.json | 30 + .../2026-05-01/ListDefenderForAISetting.json | 35 + .../ListDeletedAccountsBySubscription.json | 79 + .../2026-05-01/ListDeploymentSkus.json | 36 + .../examples/2026-05-01/ListDeployments.json | 37 + .../2026-05-01/ListEncryptionScopes.json | 43 + .../examples/2026-05-01/ListKeys.json | 18 + .../ListLocationBasedModelCapacities.json | 36 + .../2026-05-01/ListLocationModels.json | 292 + .../2026-05-01/ListModelCapacities.json | 35 + ...etworkSecurityPerimeterConfigurations.json | 51 + .../ListPrivateEndpointConnections.json | 33 + .../2026-05-01/ListPrivateLinkResources.json | 32 + .../examples/2026-05-01/ListProjects.json | 57 + .../examples/2026-05-01/ListQuotaTiers.json | 31 + .../2026-05-01/ListRaiContentFilters.json | 102 + .../ListRaiExternalSafetyProviders.json | 61 + .../examples/2026-05-01/ListRaiPolicies.json | 108 + .../2026-05-01/ListRaiToolLabels.json | 44 + .../examples/2026-05-01/ListRaiTopics.json | 31 + .../ListSharedCommitmentPlanAssociations.json | 26 + ...tSharedCommitmentPlansByResourceGroup.json | 36 + ...stSharedCommitmentPlansBySubscription.json | 35 + .../examples/2026-05-01/ListSkus.json | 32 + .../examples/2026-05-01/ListUsages.json | 26 + .../createOrUpdateManagedNetworkV2.json | 59 + .../ManagedNetwork/createOrUpdateRuleV2.json | 41 + .../deleteManagedNetworkV2.json | 20 + .../ManagedNetwork/deleteRuleV2.json | 21 + .../ManagedNetwork/getManagedNetworkV2.json | 39 + .../2026-05-01/ManagedNetwork/getRuleV2.json | 28 + .../ManagedNetwork/listManagedNetworkV2.json | 43 + .../2026-05-01/ManagedNetwork/listRuleV2.json | 44 + .../ManagedNetwork/patchManagedNetworkV2.json | 59 + .../ManagedNetwork/postOutboundRulesV2.json | 49 + .../provisionManagedNetwork.json | 24 + .../examples/2026-05-01/PauseDeployment.json | 33 + .../ProjectCapabilityHost/createOrUpdate.json | 78 + .../ProjectCapabilityHost/delete.json | 20 + .../2026-05-01/ProjectCapabilityHost/get.json | 37 + .../ProjectCapabilityHost/list.json | 40 + .../2026-05-01/ProjectConnection/create.json | 35 + .../2026-05-01/ProjectConnection/delete.json | 16 + .../2026-05-01/ProjectConnection/get.json | 27 + .../2026-05-01/ProjectConnection/list.json | 42 + .../2026-05-01/ProjectConnection/update.json | 42 + .../2026-05-01/PurgeDeletedAccount.json | 20 + .../2026-05-01/PutCommitmentPlan.json | 53 + .../2026-05-01/PutDefenderForAISetting.json | 56 + .../examples/2026-05-01/PutDeployment.json | 70 + .../2026-05-01/PutEncryptionScope.json | 79 + .../PutPrivateEndpointConnection.json | 56 + .../examples/2026-05-01/PutRaiBlocklist.json | 36 + .../2026-05-01/PutRaiBlocklistItem.json | 40 + .../PutRaiExternalSafetyProvider.json | 53 + .../examples/2026-05-01/PutRaiPolicy.json | 285 + .../examples/2026-05-01/PutRaiToolLabel.json | 95 + .../examples/2026-05-01/PutRaiTopic.json | 50 + .../2026-05-01/PutSubscriptionRaiPolicy.json | 285 + ...etworkSecurityPerimeterConfigurations.json | 53 + .../examples/2026-05-01/RegenerateKey.json | 21 + .../examples/2026-05-01/ResumeDeployment.json | 33 + .../TestRaiExternalSafetyProvider.json | 62 + .../examples/2026-05-01/UpdateAccount.json | 60 + .../UpdateDefenderForAISetting.json | 37 + .../examples/2026-05-01/UpdateDeployment.json | 45 + .../examples/2026-05-01/UpdateProjects.json | 65 + .../examples/2026-05-01/UpdateQuotaTier.json | 28 + .../UpdateSharedCommitmentPlan.json | 46 + .../CognitiveServices.Management/main.tsp | 5 + .../CognitiveServices.Management/models.tsp | 39 + .../stable/2026-05-01/cognitiveservices.json | 17125 ++++++++++++++++ .../AccountCapabilityHost/createOrUpdate.json | 55 + .../AccountCapabilityHost/delete.json | 19 + .../examples/AccountCapabilityHost/get.json | 30 + .../examples/AccountCapabilityHost/list.json | 32 + .../examples/AccountConnection/create.json | 34 + .../examples/AccountConnection/delete.json | 15 + .../examples/AccountConnection/get.json | 26 + .../examples/AccountConnection/list.json | 41 + .../examples/AccountConnection/update.json | 41 + .../examples/AddRaiBlocklistItems.json | 38 + .../AgentApplication/createOrUpdate.json | 74 + .../examples/AgentApplication/delete.json | 21 + .../examples/AgentApplication/disable.json | 15 + .../examples/AgentApplication/enable.json | 15 + .../examples/AgentApplication/get.json | 38 + .../examples/AgentApplication/list.json | 51 + .../examples/AgentApplication/listAgents.json | 56 + .../AgentDeployment/createOrUpdate.json | 109 + .../examples/AgentDeployment/delete.json | 22 + .../examples/AgentDeployment/get.json | 51 + .../examples/AgentDeployment/list.json | 54 + .../examples/AgentDeployment/start.json | 16 + .../examples/AgentDeployment/stop.json | 16 + .../examples/CalculateModelCapacity.json | 48 + .../examples/CheckDomainAvailability.json | 23 + .../examples/CheckSkuAvailability.json | 30 + .../2026-05-01/examples/CreateAccount.json | 142 + .../2026-05-01/examples/CreateAccountMin.json | 89 + .../examples/CreateOrUpdateQuotaTier.json | 40 + .../2026-05-01/examples/CreateProject.json | 98 + .../2026-05-01/examples/CreateProjectMin.json | 89 + .../examples/CreateSharedCommitmentPlan.json | 69 + ...CreateSharedCommitmentPlanAssociation.json | 38 + .../2026-05-01/examples/DeleteAccount.json | 19 + .../examples/DeleteCommitmentPlan.json | 20 + .../2026-05-01/examples/DeleteDeployment.json | 20 + .../examples/DeleteEncryptionScope.json | 19 + .../DeletePrivateEndpointConnection.json | 21 + .../2026-05-01/examples/DeleteProject.json | 20 + .../examples/DeleteRaiBlocklist.json | 19 + .../examples/DeleteRaiBlocklistItem.json | 20 + .../examples/DeleteRaiBlocklistItems.json | 18 + .../DeleteRaiExternalSafetyProvider.json | 17 + .../2026-05-01/examples/DeleteRaiPolicy.json | 19 + .../examples/DeleteRaiToolLabel.json | 22 + .../2026-05-01/examples/DeleteRaiTopic.json | 19 + .../examples/DeleteSharedCommitmentPlan.json | 19 + ...DeleteSharedCommitmentPlanAssociation.json | 20 + .../examples/DeleteSubscriptionRaiPolicy.json | 19 + .../2026-05-01/examples/GetAccount.json | 33 + .../examples/GetCommitmentPlan.json | 28 + .../examples/GetDefenderForAISetting.json | 32 + .../examples/GetDeletedAccount.json | 34 + .../2026-05-01/examples/GetDeployment.json | 34 + .../examples/GetEncryptionScope.json | 40 + ...etworkSecurityPerimeterConfigurations.json | 48 + .../2026-05-01/examples/GetOperations.json | 45 + .../GetPrivateEndpointConnection.json | 31 + .../2026-05-01/examples/GetProject.json | 36 + .../2026-05-01/examples/GetQuotaTier.json | 28 + .../2026-05-01/examples/GetRaiBlocklist.json | 22 + .../examples/GetRaiBlocklistItem.json | 24 + .../examples/GetRaiContentFilter.json | 24 + .../GetRaiExternalSafetyProvider.json | 28 + .../2026-05-01/examples/GetRaiPolicy.json | 107 + .../2026-05-01/examples/GetRaiToolLabel.json | 44 + .../2026-05-01/examples/GetRaiTopic.json | 28 + .../examples/GetSharedCommitmentPlan.json | 33 + .../GetSharedCommitmentPlanAssociation.json | 23 + .../stable/2026-05-01/examples/GetSkus.json | 2166 ++ .../examples/GetSubscriptionRaiPolicy.json | 107 + .../stable/2026-05-01/examples/GetUsages.json | 30 + .../examples/ListAccountModels.json | 189 + .../examples/ListAccountsByResourceGroup.json | 52 + .../examples/ListAccountsBySubscription.json | 79 + .../examples/ListBlocklistItems.json | 35 + .../2026-05-01/examples/ListBlocklists.json | 25 + .../examples/ListCommitmentPlans.json | 31 + .../examples/ListCommitmentTiers.json | 30 + .../examples/ListDefenderForAISetting.json | 35 + .../ListDeletedAccountsBySubscription.json | 79 + .../examples/ListDeploymentSkus.json | 36 + .../2026-05-01/examples/ListDeployments.json | 37 + .../examples/ListEncryptionScopes.json | 43 + .../stable/2026-05-01/examples/ListKeys.json | 18 + .../ListLocationBasedModelCapacities.json | 36 + .../examples/ListLocationModels.json | 292 + .../examples/ListModelCapacities.json | 35 + ...etworkSecurityPerimeterConfigurations.json | 51 + .../ListPrivateEndpointConnections.json | 33 + .../examples/ListPrivateLinkResources.json | 32 + .../2026-05-01/examples/ListProjects.json | 57 + .../2026-05-01/examples/ListQuotaTiers.json | 31 + .../examples/ListRaiContentFilters.json | 102 + .../ListRaiExternalSafetyProviders.json | 61 + .../2026-05-01/examples/ListRaiPolicies.json | 108 + .../examples/ListRaiToolLabels.json | 44 + .../2026-05-01/examples/ListRaiTopics.json | 31 + .../ListSharedCommitmentPlanAssociations.json | 26 + ...tSharedCommitmentPlansByResourceGroup.json | 36 + ...stSharedCommitmentPlansBySubscription.json | 35 + .../stable/2026-05-01/examples/ListSkus.json | 32 + .../2026-05-01/examples/ListUsages.json | 26 + .../createOrUpdateManagedNetworkV2.json | 59 + .../ManagedNetwork/createOrUpdateRuleV2.json | 41 + .../deleteManagedNetworkV2.json | 20 + .../examples/ManagedNetwork/deleteRuleV2.json | 21 + .../ManagedNetwork/getManagedNetworkV2.json | 39 + .../examples/ManagedNetwork/getRuleV2.json | 28 + .../ManagedNetwork/listManagedNetworkV2.json | 43 + .../examples/ManagedNetwork/listRuleV2.json | 44 + .../ManagedNetwork/patchManagedNetworkV2.json | 59 + .../ManagedNetwork/postOutboundRulesV2.json | 49 + .../provisionManagedNetwork.json | 24 + .../2026-05-01/examples/PauseDeployment.json | 33 + .../ProjectCapabilityHost/createOrUpdate.json | 78 + .../ProjectCapabilityHost/delete.json | 20 + .../examples/ProjectCapabilityHost/get.json | 37 + .../examples/ProjectCapabilityHost/list.json | 40 + .../examples/ProjectConnection/create.json | 35 + .../examples/ProjectConnection/delete.json | 16 + .../examples/ProjectConnection/get.json | 27 + .../examples/ProjectConnection/list.json | 42 + .../examples/ProjectConnection/update.json | 42 + .../examples/PurgeDeletedAccount.json | 20 + .../examples/PutCommitmentPlan.json | 53 + .../examples/PutDefenderForAISetting.json | 56 + .../2026-05-01/examples/PutDeployment.json | 70 + .../examples/PutEncryptionScope.json | 79 + .../PutPrivateEndpointConnection.json | 56 + .../2026-05-01/examples/PutRaiBlocklist.json | 36 + .../examples/PutRaiBlocklistItem.json | 40 + .../PutRaiExternalSafetyProvider.json | 53 + .../2026-05-01/examples/PutRaiPolicy.json | 285 + .../2026-05-01/examples/PutRaiToolLabel.json | 95 + .../2026-05-01/examples/PutRaiTopic.json | 50 + .../examples/PutSubscriptionRaiPolicy.json | 285 + ...etworkSecurityPerimeterConfigurations.json | 53 + .../2026-05-01/examples/RegenerateKey.json | 21 + .../2026-05-01/examples/ResumeDeployment.json | 33 + .../TestRaiExternalSafetyProvider.json | 62 + .../2026-05-01/examples/UpdateAccount.json | 60 + .../examples/UpdateDefenderForAISetting.json | 37 + .../2026-05-01/examples/UpdateDeployment.json | 45 + .../2026-05-01/examples/UpdateProjects.json | 65 + .../2026-05-01/examples/UpdateQuotaTier.json | 28 + .../examples/UpdateSharedCommitmentPlan.json | 46 + .../resource-manager/readme.md | 94 +- 305 files changed, 35382 insertions(+), 1 deletion(-) create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountCapabilityHost/createOrUpdate.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountCapabilityHost/delete.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountCapabilityHost/get.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountCapabilityHost/list.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountConnection/create.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountConnection/delete.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountConnection/get.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountConnection/list.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountConnection/update.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AddRaiBlocklistItems.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/createOrUpdate.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/delete.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/disable.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/enable.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/get.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/list.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/listAgents.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/createOrUpdate.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/delete.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/get.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/list.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/start.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/stop.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CalculateModelCapacity.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CheckDomainAvailability.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CheckSkuAvailability.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateAccount.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateAccountMin.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateOrUpdateQuotaTier.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateProject.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateProjectMin.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateSharedCommitmentPlan.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateSharedCommitmentPlanAssociation.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteAccount.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteCommitmentPlan.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteDeployment.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteEncryptionScope.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeletePrivateEndpointConnection.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteProject.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiBlocklist.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiBlocklistItem.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiBlocklistItems.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiExternalSafetyProvider.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiPolicy.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiToolLabel.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiTopic.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteSharedCommitmentPlan.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteSharedCommitmentPlanAssociation.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteSubscriptionRaiPolicy.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetAccount.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetCommitmentPlan.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetDefenderForAISetting.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetDeletedAccount.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetDeployment.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetEncryptionScope.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetNetworkSecurityPerimeterConfigurations.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetOperations.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetPrivateEndpointConnection.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetProject.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetQuotaTier.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiBlocklist.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiBlocklistItem.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiContentFilter.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiExternalSafetyProvider.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiPolicy.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiToolLabel.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiTopic.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetSharedCommitmentPlan.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetSharedCommitmentPlanAssociation.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetSkus.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetSubscriptionRaiPolicy.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetUsages.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListAccountModels.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListAccountsByResourceGroup.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListAccountsBySubscription.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListBlocklistItems.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListBlocklists.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListCommitmentPlans.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListCommitmentTiers.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListDefenderForAISetting.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListDeletedAccountsBySubscription.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListDeploymentSkus.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListDeployments.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListEncryptionScopes.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListKeys.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListLocationBasedModelCapacities.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListLocationModels.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListModelCapacities.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListNetworkSecurityPerimeterConfigurations.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListPrivateEndpointConnections.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListPrivateLinkResources.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListProjects.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListQuotaTiers.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListRaiContentFilters.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListRaiExternalSafetyProviders.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListRaiPolicies.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListRaiToolLabels.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListRaiTopics.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListSharedCommitmentPlanAssociations.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListSharedCommitmentPlansByResourceGroup.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListSharedCommitmentPlansBySubscription.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListSkus.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListUsages.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/createOrUpdateManagedNetworkV2.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/createOrUpdateRuleV2.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/deleteManagedNetworkV2.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/deleteRuleV2.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/getManagedNetworkV2.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/getRuleV2.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/listManagedNetworkV2.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/listRuleV2.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/patchManagedNetworkV2.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/postOutboundRulesV2.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/provisionManagedNetwork.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PauseDeployment.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectCapabilityHost/createOrUpdate.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectCapabilityHost/delete.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectCapabilityHost/get.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectCapabilityHost/list.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectConnection/create.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectConnection/delete.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectConnection/get.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectConnection/list.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectConnection/update.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PurgeDeletedAccount.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutCommitmentPlan.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutDefenderForAISetting.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutDeployment.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutEncryptionScope.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutPrivateEndpointConnection.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiBlocklist.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiBlocklistItem.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiExternalSafetyProvider.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiPolicy.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiToolLabel.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiTopic.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutSubscriptionRaiPolicy.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ReconcileNetworkSecurityPerimeterConfigurations.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/RegenerateKey.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ResumeDeployment.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/TestRaiExternalSafetyProvider.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateAccount.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateDefenderForAISetting.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateDeployment.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateProjects.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateQuotaTier.json create mode 100644 specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateSharedCommitmentPlan.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/cognitiveservices.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountCapabilityHost/createOrUpdate.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountCapabilityHost/delete.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountCapabilityHost/get.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountCapabilityHost/list.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountConnection/create.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountConnection/delete.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountConnection/get.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountConnection/list.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountConnection/update.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AddRaiBlocklistItems.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/createOrUpdate.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/delete.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/disable.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/enable.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/get.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/list.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/listAgents.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/createOrUpdate.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/delete.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/get.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/list.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/start.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/stop.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CalculateModelCapacity.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CheckDomainAvailability.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CheckSkuAvailability.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateAccount.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateAccountMin.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateOrUpdateQuotaTier.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateProject.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateProjectMin.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateSharedCommitmentPlan.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateSharedCommitmentPlanAssociation.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteAccount.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteCommitmentPlan.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteDeployment.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteEncryptionScope.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeletePrivateEndpointConnection.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteProject.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiBlocklist.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiBlocklistItem.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiBlocklistItems.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiExternalSafetyProvider.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiPolicy.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiToolLabel.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiTopic.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteSharedCommitmentPlan.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteSharedCommitmentPlanAssociation.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteSubscriptionRaiPolicy.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetAccount.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetCommitmentPlan.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetDefenderForAISetting.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetDeletedAccount.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetDeployment.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetEncryptionScope.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetNetworkSecurityPerimeterConfigurations.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetOperations.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetPrivateEndpointConnection.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetProject.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetQuotaTier.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiBlocklist.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiBlocklistItem.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiContentFilter.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiExternalSafetyProvider.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiPolicy.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiToolLabel.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiTopic.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetSharedCommitmentPlan.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetSharedCommitmentPlanAssociation.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetSkus.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetSubscriptionRaiPolicy.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetUsages.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListAccountModels.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListAccountsByResourceGroup.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListAccountsBySubscription.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListBlocklistItems.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListBlocklists.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListCommitmentPlans.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListCommitmentTiers.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListDefenderForAISetting.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListDeletedAccountsBySubscription.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListDeploymentSkus.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListDeployments.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListEncryptionScopes.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListKeys.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListLocationBasedModelCapacities.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListLocationModels.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListModelCapacities.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListNetworkSecurityPerimeterConfigurations.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListPrivateEndpointConnections.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListPrivateLinkResources.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListProjects.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListQuotaTiers.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListRaiContentFilters.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListRaiExternalSafetyProviders.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListRaiPolicies.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListRaiToolLabels.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListRaiTopics.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListSharedCommitmentPlanAssociations.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListSharedCommitmentPlansByResourceGroup.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListSharedCommitmentPlansBySubscription.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListSkus.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListUsages.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/createOrUpdateManagedNetworkV2.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/createOrUpdateRuleV2.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/deleteManagedNetworkV2.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/deleteRuleV2.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/getManagedNetworkV2.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/getRuleV2.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/listManagedNetworkV2.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/listRuleV2.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/patchManagedNetworkV2.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/postOutboundRulesV2.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/provisionManagedNetwork.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PauseDeployment.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectCapabilityHost/createOrUpdate.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectCapabilityHost/delete.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectCapabilityHost/get.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectCapabilityHost/list.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectConnection/create.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectConnection/delete.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectConnection/get.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectConnection/list.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectConnection/update.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PurgeDeletedAccount.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutCommitmentPlan.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutDefenderForAISetting.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutDeployment.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutEncryptionScope.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutPrivateEndpointConnection.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiBlocklist.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiBlocklistItem.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiExternalSafetyProvider.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiPolicy.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiToolLabel.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiTopic.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutSubscriptionRaiPolicy.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ReconcileNetworkSecurityPerimeterConfigurations.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/RegenerateKey.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ResumeDeployment.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/TestRaiExternalSafetyProvider.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateAccount.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateDefenderForAISetting.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateDeployment.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateProjects.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateQuotaTier.json create mode 100644 specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateSharedCommitmentPlan.json diff --git a/specification/cognitiveservices/CognitiveServices.Management/Account.tsp b/specification/cognitiveservices/CognitiveServices.Management/Account.tsp index 71f2908ea6ad..25a66d29aa79 100644 --- a/specification/cognitiveservices/CognitiveServices.Management/Account.tsp +++ b/specification/cognitiveservices/CognitiveServices.Management/Account.tsp @@ -248,6 +248,7 @@ interface Accounts { * Evaluate Azure Policy compliance for a set of hypothetical deployments without creating them. */ @added(Versions.v2026_03_15_preview) + @removed(Versions.v2026_05_01) @tag("CognitiveServicesAccounts") evaluateDeploymentPolicies is AccountOps.ActionSync< Account, diff --git a/specification/cognitiveservices/CognitiveServices.Management/Compute.tsp b/specification/cognitiveservices/CognitiveServices.Management/Compute.tsp index 1761cd45ad8f..aed8dcca59b1 100644 --- a/specification/cognitiveservices/CognitiveServices.Management/Compute.tsp +++ b/specification/cognitiveservices/CognitiveServices.Management/Compute.tsp @@ -19,6 +19,7 @@ namespace Microsoft.CognitiveServices; * (Cluster, ContainerInstance) via the computeType discriminator in properties. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) @parentResource(Account) model Compute is Azure.ResourceManager.ProxyResource { ...ResourceNameParameter< @@ -63,6 +64,7 @@ model Compute is Azure.ResourceManager.ProxyResource { } @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) @armResourceOperations interface Computes { /** diff --git a/specification/cognitiveservices/CognitiveServices.Management/ComputeOperation.tsp b/specification/cognitiveservices/CognitiveServices.Management/ComputeOperation.tsp index d69ad0201b0e..ce25eb1ed5b5 100644 --- a/specification/cognitiveservices/CognitiveServices.Management/ComputeOperation.tsp +++ b/specification/cognitiveservices/CognitiveServices.Management/ComputeOperation.tsp @@ -19,6 +19,7 @@ namespace Microsoft.CognitiveServices; @added(Versions.v2026_01_15_preview) @removed(Versions.v2026_03_01) @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) @subscriptionResource @parentResource(SubscriptionLocationResource) model ComputeOperationStatus @@ -34,6 +35,7 @@ model ComputeOperationStatus @added(Versions.v2026_01_15_preview) @removed(Versions.v2026_03_01) @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) @armResourceOperations interface ComputeOperations { /** @@ -58,6 +60,7 @@ interface ComputeOperations { @added(Versions.v2026_01_15_preview) @removed(Versions.v2026_03_01) @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model ComputeOperationStatusProperties { /** * The start time of the operation. @@ -88,6 +91,7 @@ model ComputeOperationStatusProperties { @added(Versions.v2026_01_15_preview) @removed(Versions.v2026_03_01) @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) union ComputeOperationStatusType { string, diff --git a/specification/cognitiveservices/CognitiveServices.Management/ManagedComputeCapacity.tsp b/specification/cognitiveservices/CognitiveServices.Management/ManagedComputeCapacity.tsp index 9dea0893488b..cc5c17191065 100644 --- a/specification/cognitiveservices/CognitiveServices.Management/ManagedComputeCapacity.tsp +++ b/specification/cognitiveservices/CognitiveServices.Management/ManagedComputeCapacity.tsp @@ -18,6 +18,7 @@ namespace Microsoft.CognitiveServices; * Provides available accelerator capacity per type and region at the subscription level. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) @subscriptionResource model ManagedComputeCapacity is Azure.ResourceManager.ProxyResource { @@ -31,6 +32,7 @@ model ManagedComputeCapacity #suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" "'ManagedComputeCapacities' is a read-only resource type that does not support delete operations" @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) @armResourceOperations(#{ omitTags: true }) interface ManagedComputeCapacities { /** diff --git a/specification/cognitiveservices/CognitiveServices.Management/ManagedComputeDeployment.tsp b/specification/cognitiveservices/CognitiveServices.Management/ManagedComputeDeployment.tsp index 57bef668b27c..8f6e17891989 100644 --- a/specification/cognitiveservices/CognitiveServices.Management/ManagedComputeDeployment.tsp +++ b/specification/cognitiveservices/CognitiveServices.Management/ManagedComputeDeployment.tsp @@ -18,6 +18,7 @@ namespace Microsoft.CognitiveServices; * Cognitive Services account managed compute deployment, backed by managed compute (GPU) resources. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) @parentResource(Account) model ManagedComputeDeployment is Azure.ResourceManager.ProxyResource { @@ -43,6 +44,7 @@ model ManagedComputeDeployment } @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) @armResourceOperations interface ManagedComputeDeployments { /** diff --git a/specification/cognitiveservices/CognitiveServices.Management/ManagedComputeUsages.tsp b/specification/cognitiveservices/CognitiveServices.Management/ManagedComputeUsages.tsp index 5302c17b3667..879d78ac24c3 100644 --- a/specification/cognitiveservices/CognitiveServices.Management/ManagedComputeUsages.tsp +++ b/specification/cognitiveservices/CognitiveServices.Management/ManagedComputeUsages.tsp @@ -15,6 +15,7 @@ namespace Microsoft.CognitiveServices; #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "'ManagedComputeUsagesOperationGroup' is a non-standard operation that doesn't map to ARM CRUD resource interface patterns" @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) interface ManagedComputeUsagesOperationGroup { /** * List managed compute quota usages for a subscription and location. diff --git a/specification/cognitiveservices/CognitiveServices.Management/Workbench.tsp b/specification/cognitiveservices/CognitiveServices.Management/Workbench.tsp index f34ea7c01120..14b3e21d79fe 100644 --- a/specification/cognitiveservices/CognitiveServices.Management/Workbench.tsp +++ b/specification/cognitiveservices/CognitiveServices.Management/Workbench.tsp @@ -19,6 +19,7 @@ namespace Microsoft.CognitiveServices; * Provides interactive compute with data access for AI development. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) @parentResource(Project) model Workbench is Azure.ResourceManager.ProxyResource { @@ -58,6 +59,7 @@ model Workbench } @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) @armResourceOperations interface Workbenches { /** diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountCapabilityHost/createOrUpdate.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountCapabilityHost/createOrUpdate.json new file mode 100644 index 000000000000..b16735b73784 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountCapabilityHost/createOrUpdate.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "capabilityHost": { + "properties": { + "customerSubnet": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet", + "enablePublicHostingEnvironment": true + } + }, + "capabilityHostName": "capabilityHostName", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "capabilityHostName", + "type": "Microsoft.CognitiveServices/accounts/capabilityHosts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/account-1/capabilityHosts/capabilityHostName", + "properties": { + "description": "string", + "customerSubnet": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubne", + "enablePublicHostingEnvironment": true, + "provisioningState": "Succeeded", + "tags": { + "string": "string" + } + } + }, + "headers": {} + }, + "201": { + "body": { + "name": "capabilityHostName", + "type": "Microsoft.CognitiveServices/accounts/capabilityHosts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/account-1/capabilityHosts/capabilityHostName", + "properties": { + "description": "string", + "customerSubnet": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubne", + "enablePublicHostingEnvironment": true, + "provisioningState": "Succeeded", + "tags": { + "string": "string" + } + } + }, + "headers": { + "Location": "example_location" + } + } + }, + "operationId": "AccountCapabilityHosts_CreateOrUpdate", + "title": "CreateOrUpdate Account CapabilityHost." +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountCapabilityHost/delete.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountCapabilityHost/delete.json new file mode 100644 index 000000000000..5133eb0a267c --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountCapabilityHost/delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "AccountCapabilityHosts_Delete", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "capabilityHostName": "capabilityHostName", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Delete Account CapabilityHost.", + "responses": { + "202": { + "headers": { + "Location": "location_header_to_poll" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountCapabilityHost/get.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountCapabilityHost/get.json new file mode 100644 index 000000000000..ea2aca6bcb02 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountCapabilityHost/get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "capabilityHostName": "capabilityHostName", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "capabilityHostName", + "type": "Microsoft.CognitiveServices/accounts/capabilityHosts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/account-1/capabilityHosts/capabilityHostName", + "properties": { + "description": "string", + "customerSubnet": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubne", + "enablePublicHostingEnvironment": true, + "provisioningState": "Succeeded", + "tags": { + "string": "string" + } + } + }, + "headers": {} + } + }, + "operationId": "AccountCapabilityHosts_Get", + "title": "Get Account CapabilityHost." +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountCapabilityHost/list.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountCapabilityHost/list.json new file mode 100644 index 000000000000..1443852661a3 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountCapabilityHost/list.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "capabilityHostName", + "type": "Microsoft.CognitiveServices/accounts/capabilityHosts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/account-1/capabilityHosts/capabilityHostName", + "properties": { + "description": "string", + "customerSubnet": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubne", + "provisioningState": "Succeeded", + "tags": { + "string": "string" + } + } + } + ] + }, + "headers": {} + } + }, + "operationId": "AccountCapabilityHosts_List", + "title": "List Account CapabilityHosts." +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountConnection/create.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountConnection/create.json new file mode 100644 index 000000000000..5d5595d0d326 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountConnection/create.json @@ -0,0 +1,34 @@ +{ + "operationId": "AccountConnections_Create", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "connection": { + "properties": { + "authType": "None", + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[target url]" + } + }, + "connectionName": "connection-1", + "resourceGroupName": "resourceGroup-1", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "CreateAccountConnection", + "responses": { + "200": { + "body": { + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/connections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/connections/connection-1", + "properties": { + "authType": "None", + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[target url]" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountConnection/delete.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountConnection/delete.json new file mode 100644 index 000000000000..7152fbb453d2 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountConnection/delete.json @@ -0,0 +1,15 @@ +{ + "operationId": "AccountConnections_Delete", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "connectionName": "connection-1", + "resourceGroupName": "resourceGroup-1", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "DeleteAccountConnection", + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountConnection/get.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountConnection/get.json new file mode 100644 index 000000000000..6f86615bf029 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountConnection/get.json @@ -0,0 +1,26 @@ +{ + "operationId": "AccountConnections_Get", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "connectionName": "connection-1", + "resourceGroupName": "resourceGroup-1", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "GetAccountConnection", + "responses": { + "200": { + "body": { + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/connections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/connections/connection-1", + "properties": { + "authType": "None", + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[target url]" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountConnection/list.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountConnection/list.json new file mode 100644 index 000000000000..24d357cd8e4a --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountConnection/list.json @@ -0,0 +1,41 @@ +{ + "operationId": "AccountConnections_List", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "category": "ContainerRegistry", + "resourceGroupName": "resourceGroup-1", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "target": "[target url]" + }, + "title": "ListAccountConnections", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/connections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/connections/connection-1", + "properties": { + "authType": "PAT", + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[target url]" + } + }, + { + "name": "connection-2", + "type": "Microsoft.CognitiveServices/accounts/connections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/connections/connection-2", + "properties": { + "authType": "PAT", + "category": "ContainerRegistry", + "target": "[target url]" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountConnection/update.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountConnection/update.json new file mode 100644 index 000000000000..e6227bf190d2 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AccountConnection/update.json @@ -0,0 +1,41 @@ +{ + "operationId": "AccountConnections_Update", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "connection": { + "properties": { + "authType": "AccessKey", + "category": "ADLSGen2", + "credentials": { + "accessKeyId": "some_string", + "secretAccessKey": "some_string" + }, + "expiryTime": "2020-01-01T00:00:00Z", + "metadata": {}, + "target": "some_string" + } + }, + "connectionName": "connection-1", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "UpdateAccountConnection", + "responses": { + "200": { + "body": { + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/connections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/connections/connection-1", + "properties": { + "authType": "AccessKey", + "category": "ADLSGen2", + "expiryTime": "2020-01-01T00:00:00Z", + "metadata": {}, + "target": "some_string" + } + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AddRaiBlocklistItems.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AddRaiBlocklistItems.json new file mode 100644 index 000000000000..25dff060eb93 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AddRaiBlocklistItems.json @@ -0,0 +1,38 @@ +{ + "operationId": "RaiBlocklistItems_BatchAdd", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiBlocklistItems": [ + { + "name": "myblocklistitem1", + "properties": { + "isRegex": true, + "pattern": "^[a-z0-9_-]{2,16}$" + } + }, + { + "name": "myblocklistitem2", + "properties": { + "isRegex": false, + "pattern": "blockwords" + } + } + ], + "raiBlocklistName": "myblocklist", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "AddRaiBlocklistItems", + "responses": { + "200": { + "body": { + "name": "myblocklist", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "description": "Brief description of the blocklist" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/createOrUpdate.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/createOrUpdate.json new file mode 100644 index 000000000000..a12c22851276 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/createOrUpdate.json @@ -0,0 +1,74 @@ +{ + "operationId": "AgentApplications_CreateOrUpdate", + "parameters": { + "name": "agent-app-1", + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "body": { + "properties": { + "description": "Sample agent application for customer support", + "displayName": "Customer Support Agent", + "tags": { + "environment": "production", + "team": "ai-platform" + } + } + }, + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Create or Update Account Agent Application.", + "responses": { + "200": { + "body": { + "name": "agent-app-1", + "type": "Microsoft.CognitiveServices/accounts/projects/applications", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1", + "properties": { + "description": "Sample agent application for customer support", + "displayName": "Customer Support Agent", + "provisioningState": "Succeeded", + "tags": { + "environment": "production", + "team": "ai-platform" + } + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + }, + "headers": {} + }, + "201": { + "body": { + "name": "agent-app-1", + "type": "Microsoft.CognitiveServices/accounts/projects/applications", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1", + "properties": { + "description": "Sample agent application for customer support", + "displayName": "Customer Support Agent", + "provisioningState": "Creating", + "tags": { + "environment": "production", + "team": "ai-platform" + } + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/delete.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/delete.json new file mode 100644 index 000000000000..e37bdb6c5e69 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/delete.json @@ -0,0 +1,21 @@ +{ + "operationId": "AgentApplications_Delete", + "parameters": { + "name": "agent-app-1", + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Delete Account Agent Application.", + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.CognitiveServices/locations/westus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2026-05-01", + "Retry-After": "10" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/disable.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/disable.json new file mode 100644 index 000000000000..397b8338d452 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/disable.json @@ -0,0 +1,15 @@ +{ + "operationId": "AgentApplications_Disable", + "parameters": { + "name": "agent-app-1", + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Disable Agent Application.", + "responses": { + "200": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/enable.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/enable.json new file mode 100644 index 000000000000..4b738572fa9c --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/enable.json @@ -0,0 +1,15 @@ +{ + "operationId": "AgentApplications_Enable", + "parameters": { + "name": "agent-app-1", + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Enable Agent Application.", + "responses": { + "200": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/get.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/get.json new file mode 100644 index 000000000000..fb5fd8e67dda --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/get.json @@ -0,0 +1,38 @@ +{ + "operationId": "AgentApplications_Get", + "parameters": { + "name": "agent-app-1", + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Get Account Agent Application.", + "responses": { + "200": { + "body": { + "name": "agent-app-1", + "type": "Microsoft.CognitiveServices/accounts/projects/applications", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1", + "properties": { + "description": "Sample agent application for customer support", + "displayName": "Customer Support Agent", + "tags": { + "environment": "production", + "team": "ai-platform" + } + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/list.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/list.json new file mode 100644 index 000000000000..5de4b0578dbe --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/list.json @@ -0,0 +1,51 @@ +{ + "operationId": "AgentApplications_List", + "parameters": { + "$skipToken": "string", + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "count": 30, + "names": [ + "agent-app-1", + "agent-app-2" + ], + "orderBy": "name", + "orderByAsc": true, + "projectName": "my-project", + "resourceGroupName": "test-rg", + "searchText": "test", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List Account Agent Applications.", + "responses": { + "200": { + "body": { + "nextLink": "string", + "value": [ + { + "name": "agent-app-1", + "type": "Microsoft.CognitiveServices/accounts/projects/applications", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1", + "properties": { + "description": "Sample agent application for customer support", + "displayName": "Customer Support Agent", + "tags": { + "environment": "production", + "team": "ai-platform" + } + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + } + ] + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/listAgents.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/listAgents.json new file mode 100644 index 000000000000..fe6586c5be07 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentApplication/listAgents.json @@ -0,0 +1,56 @@ +{ + "operationId": "AgentApplications_ListAgents", + "parameters": { + "name": "agent-app-1", + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List Agents for Agent Application.", + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "name": "CustomerSupportAgent", + "type": "Microsoft.CognitiveServices/accounts/projects/applications/agents", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/agents/agent-001", + "properties": { + "agentId": "agent-001", + "agentName": "CustomerSupportAgent" + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + }, + { + "name": "TechnicalSupportAgent", + "type": "Microsoft.CognitiveServices/accounts/projects/applications/agents", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/agents/agent-002", + "properties": { + "agentId": "agent-002", + "agentName": "TechnicalSupportAgent" + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + } + ] + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/createOrUpdate.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/createOrUpdate.json new file mode 100644 index 000000000000..183cb12050db --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/createOrUpdate.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "appName": "agent-app-1", + "body": { + "properties": { + "agents": [ + { + "agentId": "agent-123", + "agentName": "support-agent", + "agentVersion": "1.0.0" + } + ], + "deploymentType": "Managed", + "displayName": "Production Deployment", + "protocols": [ + { + "version": "1.0", + "protocol": "Agent" + } + ], + "state": "Starting" + } + }, + "deploymentName": "deployment-1", + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "deployment-1", + "type": "Microsoft.CognitiveServices/accounts/projects/applications/agentDeployments", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/agentDeployments/deployment-1", + "properties": { + "agents": [ + { + "agentId": "agent-123", + "agentName": "support-agent", + "agentVersion": "1.0.0" + } + ], + "deploymentId": "550e8400-e29b-41d4-a716-446655440001", + "deploymentType": "Managed", + "displayName": "Production Deployment", + "protocols": [ + { + "version": "1.0", + "protocol": "Agent" + } + ], + "provisioningState": "Succeeded", + "state": "Running" + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + }, + "headers": {} + }, + "201": { + "body": { + "name": "deployment-1", + "type": "Microsoft.CognitiveServices/accounts/projects/applications/agentDeployments", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/agentDeployments/deployment-1", + "properties": { + "agents": [ + { + "agentId": "agent-123", + "agentName": "support-agent", + "agentVersion": "1.0.0" + } + ], + "deploymentId": "550e8400-e29b-41d4-a716-446655440001", + "deploymentType": "Managed", + "displayName": "Production Deployment", + "protocols": [ + { + "version": "1.0", + "protocol": "Agent" + } + ], + "provisioningState": "Creating", + "state": "Starting" + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.CognitiveServices/locations/westus/operationresults/00000000-1111-2222-3333-444444444444?api-version=2026-05-01" + } + } + }, + "operationId": "AgentDeployments_CreateOrUpdate", + "title": "Create or Update Agent Deployment." +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/delete.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/delete.json new file mode 100644 index 000000000000..151416b9c7b6 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/delete.json @@ -0,0 +1,22 @@ +{ + "operationId": "AgentDeployments_Delete", + "parameters": { + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "appName": "agent-app-1", + "deploymentName": "deployment-1", + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Delete Agent Deployment.", + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.CognitiveServices/locations/westus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2026-05-01", + "Retry-After": "10" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/get.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/get.json new file mode 100644 index 000000000000..34f170045931 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/get.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "appName": "agent-app-1", + "deploymentName": "deployment-1", + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "deployment-1", + "type": "Microsoft.CognitiveServices/accounts/projects/applications/agentDeployments", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/agentDeployments/deployment-1", + "properties": { + "agents": [ + { + "agentId": "agent-123", + "agentName": "support-agent", + "agentVersion": "1.0.0" + } + ], + "deploymentId": "550e8400-e29b-41d4-a716-446655440001", + "deploymentType": "Managed", + "displayName": "Production Deployment", + "protocols": [ + { + "version": "1.0", + "protocol": "Agent" + } + ], + "provisioningState": "Succeeded", + "state": "Running" + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + }, + "headers": {} + } + }, + "operationId": "AgentDeployments_Get", + "title": "Get Agent Deployment." +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/list.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/list.json new file mode 100644 index 000000000000..68bc73a6d879 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/list.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "appName": "agent-app-1", + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "deployment-1", + "type": "Microsoft.CognitiveServices/accounts/projects/applications/agentDeployments", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/agentDeployments/deployment-1", + "properties": { + "agents": [ + { + "agentId": "agent-123", + "agentName": "support-agent", + "agentVersion": "1.0.0" + } + ], + "deploymentId": "550e8400-e29b-41d4-a716-446655440001", + "deploymentType": "Managed", + "displayName": "Production Deployment", + "protocols": [ + { + "version": "1.0", + "protocol": "Agent" + } + ], + "provisioningState": "Succeeded", + "state": "Running" + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + } + ] + }, + "headers": {} + } + }, + "operationId": "AgentDeployments_List", + "title": "List Agent Deployments." +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/start.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/start.json new file mode 100644 index 000000000000..36b350f0d289 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/start.json @@ -0,0 +1,16 @@ +{ + "operationId": "AgentDeployments_Start", + "parameters": { + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "appName": "agent-app-1", + "deploymentName": "deployment-1", + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Start Agent Deployment.", + "responses": { + "200": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/stop.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/stop.json new file mode 100644 index 000000000000..5d470de04d2d --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/AgentDeployment/stop.json @@ -0,0 +1,16 @@ +{ + "operationId": "AgentDeployments_Stop", + "parameters": { + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "appName": "agent-app-1", + "deploymentName": "deployment-1", + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Stop Agent Deployment.", + "responses": { + "200": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CalculateModelCapacity.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CalculateModelCapacity.json new file mode 100644 index 000000000000..a5b864237fed --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CalculateModelCapacity.json @@ -0,0 +1,48 @@ +{ + "operationId": "calculateModelCapacity", + "parameters": { + "api-version": "2026-05-01", + "parameters": { + "model": { + "name": "gpt-4", + "format": "OpenAI", + "version": "0613" + }, + "skuName": "ProvisionedManaged", + "workloads": [ + { + "requestParameters": { + "avgGeneratedTokens": 50, + "avgPromptTokens": 30 + }, + "requestPerMinute": 10 + }, + { + "requestParameters": { + "avgGeneratedTokens": 20, + "avgPromptTokens": 60 + }, + "requestPerMinute": 20 + } + ] + }, + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Calculate Model Capacity", + "responses": { + "200": { + "body": { + "estimatedCapacity": { + "deployableValue": 400, + "value": 346 + }, + "model": { + "name": "gpt-4", + "format": "OpenAI", + "version": "0613" + }, + "skuName": "ProvisionedManaged" + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CheckDomainAvailability.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CheckDomainAvailability.json new file mode 100644 index 000000000000..46355a107efa --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CheckDomainAvailability.json @@ -0,0 +1,23 @@ +{ + "operationId": "CheckDomainAvailability", + "parameters": { + "api-version": "2026-05-01", + "location": "westus", + "parameters": { + "type": "Microsoft.CognitiveServices/accounts", + "subdomainName": "contosodemoapp1" + }, + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Check SKU Availability", + "responses": { + "200": { + "body": { + "type": "Microsoft.CognitiveServices/accounts", + "isSubdomainAvailable": false, + "reason": "Sub domain name 'contosodemoapp1' is not valid", + "subdomainName": "contosodemoapp1" + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CheckSkuAvailability.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CheckSkuAvailability.json new file mode 100644 index 000000000000..8eaf96a07b79 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CheckSkuAvailability.json @@ -0,0 +1,30 @@ +{ + "operationId": "CheckSkuAvailability", + "parameters": { + "api-version": "2026-05-01", + "location": "westus", + "parameters": { + "type": "Microsoft.CognitiveServices/accounts", + "kind": "Face", + "skus": [ + "S0" + ] + }, + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Check SKU Availability", + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.CognitiveServices/accounts", + "kind": "Face", + "skuAvailable": true, + "skuName": "S0" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateAccount.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateAccount.json new file mode 100644 index 000000000000..f4f6ca5af59a --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateAccount.json @@ -0,0 +1,142 @@ +{ + "operationId": "Accounts_Create", + "parameters": { + "account": { + "identity": { + "type": "SystemAssigned" + }, + "kind": "Emotion", + "location": "West US", + "properties": { + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "KeyName", + "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/", + "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA" + } + }, + "userOwnedStorage": [ + { + "resourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount" + } + ] + }, + "sku": { + "name": "S0" + } + }, + "accountName": "testCreate1", + "api-version": "2026-05-01", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Create Account", + "responses": { + "200": { + "body": { + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "Emotion", + "location": "West US", + "properties": { + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "FakeKeyName", + "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/", + "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA" + } + }, + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded", + "userOwnedStorage": [ + { + "resourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount" + } + ] + }, + "sku": { + "name": "S0" + } + } + }, + "201": { + "body": { + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "Emotion", + "location": "West US", + "properties": { + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "FakeKeyName", + "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/", + "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA" + } + }, + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded", + "userOwnedStorage": [ + { + "resourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount" + } + ] + }, + "sku": { + "name": "S0" + } + } + }, + "202": { + "body": { + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "Emotion", + "location": "West US", + "properties": { + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "FakeKeyName", + "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/", + "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA" + } + }, + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded", + "userOwnedStorage": [ + { + "resourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount" + } + ] + }, + "sku": { + "name": "S0" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateAccountMin.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateAccountMin.json new file mode 100644 index 000000000000..5baf9f41608f --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateAccountMin.json @@ -0,0 +1,89 @@ +{ + "operationId": "Accounts_Create", + "parameters": { + "account": { + "identity": { + "type": "SystemAssigned" + }, + "kind": "CognitiveServices", + "location": "West US", + "properties": {}, + "sku": { + "name": "S0" + } + }, + "accountName": "testCreate1", + "api-version": "2026-05-01", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Create Account Min", + "responses": { + "200": { + "body": { + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "Emotion", + "location": "West US", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + } + }, + "201": { + "body": { + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "Emotion", + "location": "West US", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + } + }, + "202": { + "body": { + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "Emotion", + "location": "West US", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateOrUpdateQuotaTier.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateOrUpdateQuotaTier.json new file mode 100644 index 000000000000..fcb23177b869 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateOrUpdateQuotaTier.json @@ -0,0 +1,40 @@ +{ + "operationId": "QuotaTiers_CreateOrUpdate", + "parameters": { + "default": "default", + "api-version": "2026-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tier": { + "properties": { + "tierUpgradePolicy": "NoAutoUpgrade" + } + } + }, + "title": "Update the quota tier resource for a subscription", + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.CognitiveServices/quotaTiers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/quotaTiers/default", + "properties": { + "assignmentDate": "2025-06-09T18:13:29.389Z", + "currentTierName": "Free-Tier", + "tierUpgradePolicy": "NoAutoUpgrade" + } + } + }, + "201": { + "body": { + "name": "default", + "type": "Microsoft.CognitiveServices/quotaTiers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/quotaTiers/default", + "properties": { + "assignmentDate": "2025-06-09T18:13:29.389Z", + "currentTierName": "Free-Tier", + "tierUpgradePolicy": "NoAutoUpgrade" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateProject.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateProject.json new file mode 100644 index 000000000000..d0b3451357af --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateProject.json @@ -0,0 +1,98 @@ +{ + "operationId": "Projects_Create", + "parameters": { + "accountName": "testCreate1", + "api-version": "2026-05-01", + "project": { + "identity": { + "type": "SystemAssigned" + }, + "location": "West US", + "properties": { + "description": "Description of this project", + "displayName": "p1" + } + }, + "projectName": "testProject1", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Create Project", + "responses": { + "200": { + "body": { + "name": "testProject1", + "type": "Microsoft.CognitiveServices/accounts/projects", + "etag": "W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1/projects/testProject1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "location": "West US", + "properties": { + "description": "Description of this project", + "displayName": "p1", + "endpoints": { + "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/" + }, + "isDefault": true, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "testProject1", + "type": "Microsoft.CognitiveServices/accounts/projects", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1/projects/testProject1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "location": "West US", + "properties": { + "description": "Description of this project", + "displayName": "p1", + "endpoints": { + "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/" + }, + "isDefault": true, + "provisioningState": "Succeeded" + } + } + }, + "202": { + "body": { + "name": "testProject1", + "type": "Microsoft.CognitiveServices/accounts/projects", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1/projects/testProject1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "location": "West US", + "properties": { + "description": "Description of this project", + "displayName": "p1", + "endpoints": { + "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/" + }, + "isDefault": true, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateProjectMin.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateProjectMin.json new file mode 100644 index 000000000000..0a6d6b19e897 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateProjectMin.json @@ -0,0 +1,89 @@ +{ + "operationId": "Projects_Create", + "parameters": { + "accountName": "testCreate1", + "api-version": "2026-05-01", + "project": { + "identity": { + "type": "SystemAssigned" + }, + "location": "West US", + "properties": {} + }, + "projectName": "testProject1", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Create Project Min", + "responses": { + "200": { + "body": { + "name": "testProject1", + "type": "Microsoft.CognitiveServices/accounts/projects", + "etag": "W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1/projects/testProject1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "location": "West US", + "properties": { + "endpoints": { + "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/" + }, + "isDefault": true, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "testProject1", + "type": "Microsoft.CognitiveServices/accounts/projects", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1/projects/testProject1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "location": "West US", + "properties": { + "endpoints": { + "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/" + }, + "isDefault": true, + "provisioningState": "Succeeded" + } + } + }, + "202": { + "body": { + "name": "testProject1", + "type": "Microsoft.CognitiveServices/accounts/projects", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1/projects/testProject1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "location": "West US", + "properties": { + "endpoints": { + "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/" + }, + "isDefault": true, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateSharedCommitmentPlan.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateSharedCommitmentPlan.json new file mode 100644 index 000000000000..7e8f3323cfe3 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateSharedCommitmentPlan.json @@ -0,0 +1,69 @@ +{ + "operationId": "CommitmentPlans_CreateOrUpdatePlan", + "parameters": { + "api-version": "2026-05-01", + "commitmentPlan": { + "kind": "SpeechServices", + "location": "West US", + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "STT" + }, + "sku": { + "name": "S0" + } + }, + "commitmentPlanName": "commitmentPlanName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Create Commitment Plan", + "responses": { + "200": { + "body": { + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "kind": "SpeechServices", + "location": "West US", + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "STT", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + } + }, + "201": { + "body": { + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "kind": "SpeechServices", + "location": "West US", + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "STT", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateSharedCommitmentPlanAssociation.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateSharedCommitmentPlanAssociation.json new file mode 100644 index 000000000000..2a53f8eb116c --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/CreateSharedCommitmentPlanAssociation.json @@ -0,0 +1,38 @@ +{ + "operationId": "CommitmentPlans_CreateOrUpdateAssociation", + "parameters": { + "api-version": "2026-05-01", + "association": { + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + }, + "commitmentPlanAssociationName": "commitmentPlanAssociationName", + "commitmentPlanName": "commitmentPlanName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "PutCommitmentPlan", + "responses": { + "200": { + "body": { + "name": "commitmentPlanAssociationName", + "type": "Microsoft.CognitiveServices/commitmentPlans/accountAssociations", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName/accountAssociations/commitmentPlanAssociationName", + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + } + }, + "201": { + "body": { + "name": "commitmentPlanAssociationName", + "type": "Microsoft.CognitiveServices/commitmentPlans/accountAssociations", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName/accountAssociations/commitmentPlanAssociationName", + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteAccount.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteAccount.json new file mode 100644 index 000000000000..68e8a8cc47d9 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteAccount.json @@ -0,0 +1,19 @@ +{ + "operationId": "Accounts_Delete", + "parameters": { + "accountName": "PropTest01", + "api-version": "2026-05-01", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Delete Account", + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteCommitmentPlan.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteCommitmentPlan.json new file mode 100644 index 000000000000..503e1e964add --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteCommitmentPlan.json @@ -0,0 +1,20 @@ +{ + "operationId": "CommitmentPlans_Delete", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "commitmentPlanName": "commitmentPlanName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "DeleteCommitmentPlan", + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteDeployment.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteDeployment.json new file mode 100644 index 000000000000..dbf43910032e --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteDeployment.json @@ -0,0 +1,20 @@ +{ + "operationId": "Deployments_Delete", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "deploymentName": "deploymentName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "DeleteDeployment", + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteEncryptionScope.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteEncryptionScope.json new file mode 100644 index 000000000000..cac0afef39b3 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteEncryptionScope.json @@ -0,0 +1,19 @@ +{ + "operationId": "EncryptionScopes_Delete", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "encryptionScopeName": "encryptionScopeName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "DeleteEncryptionScope", + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeletePrivateEndpointConnection.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..d4c986d4f85a --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeletePrivateEndpointConnection.json @@ -0,0 +1,21 @@ +{ + "operationId": "PrivateEndpointConnections_Delete", + "parameters": { + "accountName": "sto2527", + "api-version": "2026-05-01", + "monitor": "true", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "resourceGroupName": "res6977", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "DeletePrivateEndpointConnection", + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteProject.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteProject.json new file mode 100644 index 000000000000..a1355969120a --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteProject.json @@ -0,0 +1,20 @@ +{ + "operationId": "Projects_Delete", + "parameters": { + "accountName": "PropTest01", + "api-version": "2026-05-01", + "projectName": "myProject", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Delete Project", + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiBlocklist.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiBlocklist.json new file mode 100644 index 000000000000..adc7180ea0e7 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiBlocklist.json @@ -0,0 +1,19 @@ +{ + "operationId": "RaiBlocklists_Delete", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiBlocklistName": "raiBlocklistName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "DeleteRaiBlocklist", + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiBlocklistItem.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiBlocklistItem.json new file mode 100644 index 000000000000..cb3881ad3bc6 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiBlocklistItem.json @@ -0,0 +1,20 @@ +{ + "operationId": "RaiBlocklistItems_Delete", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiBlocklistItemName": "raiBlocklistItemName", + "raiBlocklistName": "raiBlocklistName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "DeleteRaiBlocklistItem", + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiBlocklistItems.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiBlocklistItems.json new file mode 100644 index 000000000000..9b0c988edf1d --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiBlocklistItems.json @@ -0,0 +1,18 @@ +{ + "operationId": "RaiBlocklistItems_BatchDelete", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiBlocklistItemsNames": [ + "myblocklistitem1", + "myblocklistitem2" + ], + "raiBlocklistName": "raiBlocklistName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "DeleteRaiBlocklistItems", + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiExternalSafetyProvider.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiExternalSafetyProvider.json new file mode 100644 index 000000000000..2aaee5884b80 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiExternalSafetyProvider.json @@ -0,0 +1,17 @@ +{ + "operationId": "RaiExternalSafetyProvider_Delete", + "parameters": { + "api-version": "2026-05-01", + "safetyProviderName": "safetyProviderName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "DeleteRaiTopic", + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiPolicy.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiPolicy.json new file mode 100644 index 000000000000..a162de7fea99 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiPolicy.json @@ -0,0 +1,19 @@ +{ + "operationId": "RaiPolicies_Delete", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiPolicyName": "raiPolicyName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "DeleteRaiPolicy", + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiToolLabel.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiToolLabel.json new file mode 100644 index 000000000000..5c5000d2ab2f --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiToolLabel.json @@ -0,0 +1,22 @@ +{ + "operationId": "RaiToolLabels_Delete", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiToolConnectionName": "Web_Search", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "DeleteRaiToolLabel", + "responses": { + "202": { + "description": "Accepted -- delete operation started.", + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "description": "No Content -- RAI Tool Label does not exist." + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiTopic.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiTopic.json new file mode 100644 index 000000000000..4abe8a744fca --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteRaiTopic.json @@ -0,0 +1,19 @@ +{ + "operationId": "RaiTopics_Delete", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiTopicName": "raiTopicName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "DeleteRaiTopic", + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteSharedCommitmentPlan.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteSharedCommitmentPlan.json new file mode 100644 index 000000000000..72d623075724 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteSharedCommitmentPlan.json @@ -0,0 +1,19 @@ +{ + "operationId": "CommitmentPlans_DeletePlan", + "parameters": { + "api-version": "2026-05-01", + "commitmentPlanName": "commitmentPlanName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Delete Commitment Plan", + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteSharedCommitmentPlanAssociation.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteSharedCommitmentPlanAssociation.json new file mode 100644 index 000000000000..d334fc51db7c --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteSharedCommitmentPlanAssociation.json @@ -0,0 +1,20 @@ +{ + "operationId": "CommitmentPlans_DeleteAssociation", + "parameters": { + "api-version": "2026-05-01", + "commitmentPlanAssociationName": "commitmentPlanAssociationName", + "commitmentPlanName": "commitmentPlanName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "DeleteCommitmentPlan", + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteSubscriptionRaiPolicy.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteSubscriptionRaiPolicy.json new file mode 100644 index 000000000000..bbe475fc4ceb --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/DeleteSubscriptionRaiPolicy.json @@ -0,0 +1,19 @@ +{ + "operationId": "SubscriptionRaiPolicy_Delete", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiPolicyName": "raiPolicyName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "DeleteRaiPolicy", + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetAccount.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetAccount.json new file mode 100644 index 000000000000..312eb6c5a2cf --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetAccount.json @@ -0,0 +1,33 @@ +{ + "operationId": "Accounts_Get", + "parameters": { + "accountName": "myAccount", + "api-version": "2026-05-01", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Get Account", + "responses": { + "200": { + "body": { + "name": "myAccount", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount", + "kind": "Emotion", + "location": "westus", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "F0" + }, + "tags": { + "ExpiredDate": "2017/09/01", + "Owner": "felixwa" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetCommitmentPlan.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetCommitmentPlan.json new file mode 100644 index 000000000000..ade147f22178 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetCommitmentPlan.json @@ -0,0 +1,28 @@ +{ + "operationId": "CommitmentPlans_Get", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "commitmentPlanName": "commitmentPlanName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "GetCommitmentPlan", + "responses": { + "200": { + "body": { + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/accounts/commitmentPlans", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/commitmentPlans/commitmentPlanName", + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "Speech2Text" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetDefenderForAISetting.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetDefenderForAISetting.json new file mode 100644 index 000000000000..60b750bd2a05 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetDefenderForAISetting.json @@ -0,0 +1,32 @@ +{ + "operationId": "DefenderForAISettings_Get", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "defenderForAISettingName": "Default", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "GetDefenderForAISetting", + "responses": { + "200": { + "body": { + "name": "Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdAt": "2022-04-03T04:41:33.937Z", + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetDeletedAccount.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetDeletedAccount.json new file mode 100644 index 000000000000..d1d65db024fc --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetDeletedAccount.json @@ -0,0 +1,34 @@ +{ + "operationId": "DeletedAccounts_Get", + "parameters": { + "accountName": "myAccount", + "api-version": "2026-05-01", + "location": "westus", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Get Account", + "responses": { + "200": { + "body": { + "name": "myAccount", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.CognitiveServices/locations/westus/resourceGroups/myResourceGroup/deletedAccounts/myAccount", + "kind": "Emotion", + "location": "westus", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "F0" + }, + "tags": { + "ExpiredDate": "2017/09/01", + "Owner": "felixwa" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetDeployment.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetDeployment.json new file mode 100644 index 000000000000..e0730e53bb3a --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetDeployment.json @@ -0,0 +1,34 @@ +{ + "operationId": "Deployments_Get", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "deploymentName": "deploymentName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "GetDeployment", + "responses": { + "200": { + "body": { + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "properties": { + "deploymentState": "Running", + "model": { + "name": "ada", + "format": "OpenAI", + "version": "1" + }, + "provisioningState": "Succeeded", + "serviceTier": "Default" + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetEncryptionScope.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetEncryptionScope.json new file mode 100644 index 000000000000..9669dac48e6b --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetEncryptionScope.json @@ -0,0 +1,40 @@ +{ + "operationId": "EncryptionScopes_Get", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "encryptionScopeName": "encryptionScopeName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "GetEncryptionScope", + "responses": { + "200": { + "body": { + "name": "encryptionScopeName", + "type": "Microsoft.CognitiveServices/accounts/encryptionScopes", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName", + "properties": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "identityClientId": "00000000-0000-0000-0000-000000000000", + "keyName": "DevKeyWestUS2", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95" + }, + "provisioningState": "Succeeded", + "state": "Enabled" + }, + "systemData": { + "createdAt": "2023-06-08T06:35:08.0662558Z", + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2023-06-08T06:35:08.0662558Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetNetworkSecurityPerimeterConfigurations.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetNetworkSecurityPerimeterConfigurations.json new file mode 100644 index 000000000000..371d20f5150b --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetNetworkSecurityPerimeterConfigurations.json @@ -0,0 +1,48 @@ +{ + "operationId": "NetworkSecurityPerimeterConfigurations_Get", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "nspConfigurationName": "NSPConfigurationName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "GetNetworkSecurityPerimeterConfigurations", + "responses": { + "200": { + "body": { + "name": "networkSecurityPerimeterConfigurationName", + "type": "Microsoft.CognitiveServices/accounts/networkSecurityPerimeterConfigurations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/networkSecurityPerimeterConfigurations/config1", + "properties": { + "networkSecurityPerimeter": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.Network/networkSecurityPerimeters/perimeter", + "location": "East US", + "perimeterGuid": "00000000-0000-0000-0000-000000000000" + }, + "profile": { + "name": "profileName", + "accessRules": [ + { + "name": "ruleName", + "properties": { + "addressPrefixes": [ + "148.0.0.0/8", + "152.4.6.0/24" + ], + "direction": "Inbound" + } + } + ], + "accessRulesVersion": 1 + }, + "provisioningState": "Succeeded", + "resourceAssociation": { + "name": "associationName", + "accessMode": "Enforced" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetOperations.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetOperations.json new file mode 100644 index 000000000000..0e03252e67aa --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetOperations.json @@ -0,0 +1,45 @@ +{ + "operationId": "Operations_List", + "parameters": { + "api-version": "2026-05-01" + }, + "title": "Get Operations", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.CognitiveServices/accounts/read", + "display": { + "description": "Reads API accounts.", + "operation": "Read API Account", + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CognitiveServices/accounts/write", + "display": { + "description": "Writes API Accounts.", + "operation": "Write API Account", + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CognitiveServices/accounts/delete", + "display": { + "description": "Deletes API accounts", + "operation": "Delete API Account", + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account" + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetPrivateEndpointConnection.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetPrivateEndpointConnection.json new file mode 100644 index 000000000000..265b022ac3ef --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetPrivateEndpointConnection.json @@ -0,0 +1,31 @@ +{ + "operationId": "PrivateEndpointConnections_Get", + "parameters": { + "accountName": "sto2527", + "api-version": "2026-05-01", + "monitor": "true", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "resourceGroupName": "res6977", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "GetPrivateEndpointConnection", + "responses": { + "200": { + "body": { + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "description": "Auto-Approved", + "actionsRequired": "None", + "status": "Approved" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetProject.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetProject.json new file mode 100644 index 000000000000..c0f9ed8e0488 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetProject.json @@ -0,0 +1,36 @@ +{ + "operationId": "Projects_Get", + "parameters": { + "accountName": "myAccount", + "api-version": "2026-05-01", + "projectName": "myProject", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Get Project", + "responses": { + "200": { + "body": { + "name": "myProject", + "type": "Microsoft.CognitiveServices/accounts/projects", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount/projects/myProject", + "location": "westus", + "properties": { + "description": "This is my project", + "displayName": "myProject", + "endpoints": { + "OpenAI Dall-E API": "https://customSubDomainName.openai.azure.com/", + "OpenAI Language Model Instance API": "https://customSubDomainName.openai.azure.com/" + }, + "isDefault": false, + "provisioningState": "Succeeded" + }, + "tags": { + "ExpiredDate": "2017/09/01", + "Owner": "felixwa" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetQuotaTier.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetQuotaTier.json new file mode 100644 index 000000000000..43cf0e5dc723 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetQuotaTier.json @@ -0,0 +1,28 @@ +{ + "operationId": "QuotaTiers_Get", + "parameters": { + "default": "default", + "api-version": "2026-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Get the Quota Tier information for a subscription", + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.CognitiveServices/quotaTiers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/quotaTiers/default", + "properties": { + "assignmentDate": "2025-06-09T18:13:29.389Z", + "currentTierName": "Free-Tier", + "tierUpgradeEligibilityInfo": { + "nextTierName": "Tier-1", + "upgradeApplicableDate": "2025-06-15T18:13:29.389Z", + "upgradeAvailabilityStatus": "Available" + }, + "tierUpgradePolicy": "OnceUpgradeIsAvailable" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiBlocklist.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiBlocklist.json new file mode 100644 index 000000000000..65f121ccb367 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiBlocklist.json @@ -0,0 +1,22 @@ +{ + "operationId": "RaiBlocklists_Get", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiBlocklistName": "raiBlocklistName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "GetRaiBlocklist", + "responses": { + "200": { + "body": { + "name": "raiBlocklistName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName", + "properties": { + "description": "This is a sample blocklist" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiBlocklistItem.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiBlocklistItem.json new file mode 100644 index 000000000000..affabdea848c --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiBlocklistItem.json @@ -0,0 +1,24 @@ +{ + "operationId": "RaiBlocklistItems_Get", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiBlocklistItemName": "raiBlocklistItemName", + "raiBlocklistName": "raiBlocklistName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "GetRaiBlocklistItem", + "responses": { + "200": { + "body": { + "name": "raiBlocklistItemName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName", + "properties": { + "isRegex": false, + "pattern": "Pattern To Block" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiContentFilter.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiContentFilter.json new file mode 100644 index 000000000000..fd6f4f71348a --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiContentFilter.json @@ -0,0 +1,24 @@ +{ + "operationId": "RaiContentFilters_Get", + "parameters": { + "api-version": "2026-05-01", + "filterName": "IndirectAttack", + "location": "WestUS", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "GetRaiContentFilters", + "responses": { + "200": { + "body": { + "name": "IndirectAttack", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/IndirectAttack", + "properties": { + "name": "Indirect Attack", + "isMultiLevelFilter": false, + "source": "Prompt" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiExternalSafetyProvider.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiExternalSafetyProvider.json new file mode 100644 index 000000000000..06fe22836b70 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiExternalSafetyProvider.json @@ -0,0 +1,28 @@ +{ + "operationId": "RaiExternalSafetyProvider_Get", + "parameters": { + "api-version": "2026-05-01", + "safetyProviderName": "safetyProviderName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "GetRaiExternalSafetyProvider", + "responses": { + "200": { + "body": { + "name": "safetyProviderName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/raiExternalSafetyProviders/safetyProviderName", + "properties": { + "createdAt": "2025-07-01T00:00:00Z", + "keyVaultUri": "https://example.vault.azure.net", + "lastModifiedAt": "2025-07-02T00:00:00Z", + "managedIdentity": "00000000-0000-0000-0000-000000000000", + "mode": "sync", + "providerId": "00000000-0000-0000-0000-000000000000", + "providerName": "safetyProviderName", + "secretName": "mySecretName", + "url": "https://example.webhook.endpoint" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiPolicy.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiPolicy.json new file mode 100644 index 000000000000..5b655b4b5bb1 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiPolicy.json @@ -0,0 +1,107 @@ +{ + "operationId": "RaiPolicies_Get", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "deploymentName": "deploymentName", + "effective": true, + "raiPolicyName": "raiPolicyName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "GetRaiPolicy", + "responses": { + "200": { + "body": { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "contentFilters": [ + { + "name": "Hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Jailbreak", + "blocking": true, + "enabled": true, + "source": "Prompt" + }, + { + "name": "Protected Material Text", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Protected Material Code", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Profanity", + "blocking": true, + "enabled": true, + "source": "Prompt" + } + ], + "mode": "Asynchronous_filter" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiToolLabel.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiToolLabel.json new file mode 100644 index 000000000000..3963fc3cf59c --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiToolLabel.json @@ -0,0 +1,44 @@ +{ + "operationId": "RaiToolLabels_Get", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiToolConnectionName": "ToolLabelName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "GetRaiToolLabel", + "responses": { + "200": { + "body": { + "name": "raiToolLabelName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiIfcToolLabels/raiIfcToolLabelName", + "properties": { + "accountScope": { + "labelValues": { + "confidentiality": "low", + "dataDirection": "egress" + } + }, + "projectScopes": [ + { + "labelValues": { + "confidentiality": "low", + "dataDirection": "egress" + }, + "project": "ProjectA" + }, + { + "labelValues": { + "confidentiality": "high", + "dataDirection": "egress" + }, + "project": "ProjectB" + } + ], + "toolConnectionName": "SampleToolLabel" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiTopic.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiTopic.json new file mode 100644 index 000000000000..6c0cd70b3777 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetRaiTopic.json @@ -0,0 +1,28 @@ +{ + "operationId": "RaiTopics_Get", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiTopicName": "raiTopicName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "GetRaiTopic", + "responses": { + "200": { + "body": { + "name": "raiTopicName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiTopics/raiTopicName", + "properties": { + "description": "This is a sample topic.", + "createdAt": "2025-07-01T00:00:00Z", + "lastModifiedAt": "2025-07-02T00:00:00Z", + "sampleBlobUrl": "https://example.blob.core.windows.net/sampleblob", + "status": "Succeeded", + "topicId": "00000000-0000-0000-0000-000000000000", + "topicName": "raiTopicName" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetSharedCommitmentPlan.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetSharedCommitmentPlan.json new file mode 100644 index 000000000000..e20ec3233f8e --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetSharedCommitmentPlan.json @@ -0,0 +1,33 @@ +{ + "operationId": "CommitmentPlans_GetPlan", + "parameters": { + "api-version": "2026-05-01", + "commitmentPlanName": "commitmentPlanName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Get Commitment Plan", + "responses": { + "200": { + "body": { + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "kind": "SpeechServices", + "location": "West US", + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "STT", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetSharedCommitmentPlanAssociation.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetSharedCommitmentPlanAssociation.json new file mode 100644 index 000000000000..14e77da3f6e9 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetSharedCommitmentPlanAssociation.json @@ -0,0 +1,23 @@ +{ + "operationId": "CommitmentPlans_GetAssociation", + "parameters": { + "api-version": "2026-05-01", + "commitmentPlanAssociationName": "commitmentPlanAssociationName", + "commitmentPlanName": "commitmentPlanName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "GetCommitmentPlan", + "responses": { + "200": { + "body": { + "name": "commitmentPlanAssociationName", + "type": "Microsoft.CognitiveServices/commitmentPlans/accountAssociations", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName/accountAssociations/commitmentPlanAssociationName", + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetSkus.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetSkus.json new file mode 100644 index 000000000000..6e8cbf684420 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetSkus.json @@ -0,0 +1,2166 @@ +{ + "operationId": "ResourceSkus_List", + "parameters": { + "api-version": "2026-05-01", + "subscriptionId": "f1c637e4-72ec-4f89-8d2b-0f933c036002" + }, + "title": "Regenerate Keys", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "F0", + "kind": "Bing.Speech", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Bing.Speech", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S5", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S6", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S7", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S8", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "Bing.Autosuggest.v7", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "Bing.CustomSearch", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "Bing.SpellCheck.v7", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Bing.EntitySearch", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "Bing.EntitySearch", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "SpeakerRecognition", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "SpeakerRecognition", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "CustomSpeech", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S2", + "kind": "CustomSpeech", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "CustomVision.Training", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "CustomVision.Training", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "CustomVision.Prediction", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "CustomVision.Prediction", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetSubscriptionRaiPolicy.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetSubscriptionRaiPolicy.json new file mode 100644 index 000000000000..0eb9caf953e3 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetSubscriptionRaiPolicy.json @@ -0,0 +1,107 @@ +{ + "operationId": "SubscriptionRaiPolicy_Get", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "deploymentName": "deploymentName", + "effective": true, + "raiPolicyName": "raiPolicyName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "GetRaiPolicy", + "responses": { + "200": { + "body": { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "contentFilters": [ + { + "name": "Hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Jailbreak", + "blocking": true, + "enabled": true, + "source": "Prompt" + }, + { + "name": "Protected Material Text", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Protected Material Code", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Profanity", + "blocking": true, + "enabled": true, + "source": "Prompt" + } + ], + "mode": "Asynchronous_filter" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetUsages.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetUsages.json new file mode 100644 index 000000000000..69b2d2211bde --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/GetUsages.json @@ -0,0 +1,30 @@ +{ + "operationId": "Accounts_ListUsages", + "parameters": { + "accountName": "TestUsage02", + "api-version": "2026-05-01", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "5a4f5c2e-6983-4ccb-bd34-2196d5b5bbd3" + }, + "title": "Get Usages", + "responses": { + "200": { + "body": { + "value": [ + { + "name": { + "localizedValue": "Face.Transactions", + "value": "Face.Transactions" + }, + "currentValue": 3, + "limit": 30000, + "nextResetTime": "2018-03-28T09:33:51Z", + "quotaPeriod": "30.00:00:00", + "status": "Included", + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListAccountModels.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListAccountModels.json new file mode 100644 index 000000000000..4f624d8b5503 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListAccountModels.json @@ -0,0 +1,189 @@ +{ + "operationId": "Accounts_ListModels", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "location": "location", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List AccountModels", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ada.1", + "format": "OpenAI", + "baseModel": { + "name": "ada", + "format": "OpenAI", + "version": "1" + }, + "capabilities": { + "completion": "true", + "fineTune": "true", + "inference": "false" + }, + "deprecation": { + "deprecationStatus": "Planned", + "fineTune": "2024-01-01T00:00:00Z", + "inference": "2024-01-01T00:00:00Z" + }, + "isDefaultVersion": false, + "lifecycleStatus": "Legacy", + "maxCapacity": 10, + "systemData": { + "createdAt": "2021-10-07T00:00:00Z", + "createdBy": "Microsoft", + "createdByType": "Application", + "lastModifiedAt": "2021-10-07T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedByType": "Application" + }, + "version": "1" + }, + { + "name": "dall-e-3", + "format": "OpenAI", + "capabilities": { + "imageGenerations": "true", + "inference": "true" + }, + "deprecation": { + "deprecationStatus": "Tentative", + "inference": "2025-06-30T00:00:00Z" + }, + "isDefaultVersion": true, + "lifecycleStatus": "GenerallyAvailable", + "maxCapacity": 2, + "modelCatalogAssetId": "azureml://registries/azure-openai/models/dall-e-3/versions/3.0", + "systemData": { + "createdAt": "2023-08-11T00:00:00Z", + "createdBy": "Microsoft", + "createdByType": "Application", + "lastModifiedAt": "2023-08-11T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedByType": "Application" + }, + "version": "3.0" + }, + { + "name": "gpt-35-turbo", + "format": "OpenAI", + "capabilities": { + "chatCompletion": "true", + "completion": "true", + "fineTune": "false", + "scaleType": "Manual,Standard" + }, + "deprecation": { + "deprecationStatus": "Planned", + "inference": "2025-04-30T00:00:00Z" + }, + "isDefaultVersion": false, + "lifecycleStatus": "Deprecated", + "maxCapacity": 9, + "systemData": { + "createdAt": "2023-03-09T00:00:00Z", + "createdBy": "Microsoft", + "createdByType": "Application", + "lastModifiedAt": "2023-07-06T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedByType": "Application" + }, + "version": "0301" + }, + { + "name": "gpt-4o", + "format": "OpenAI", + "capabilities": { + "chat": "true", + "completion": "true", + "fineTune": "false", + "inference": "true", + "vision": "true" + }, + "deprecation": { + "deprecationStatus": "Tentative", + "inference": "2025-09-15T00:00:00Z" + }, + "lifecycleStatus": "Deprecating", + "maxCapacity": 50, + "modelCatalogAssetId": "azureml://registries/azure-openai/models/gpt-4o/versions/2024-05-13", + "replacementConfig": { + "autoUpgradeStartDate": "2025-03-26T07:00:00Z", + "targetModelName": "gpt-4.1", + "targetModelVersion": "2025-04-14", + "upgradeOnExpiryLeadTimeDays": 7 + }, + "systemData": { + "createdAt": "2024-05-13T00:00:00Z", + "createdBy": "Microsoft", + "createdByType": "Application", + "lastModifiedAt": "2024-12-15T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedByType": "Application" + }, + "version": "2024-05-13" + }, + { + "name": "Llama-3.2-90B-Vision-Instruct", + "format": "Meta", + "capabilities": { + "chatCompletion": "true" + }, + "deprecation": { + "deprecationStatus": "Tentative", + "inference": "2099-12-31T00:00:00Z" + }, + "isDefaultVersion": false, + "lifecycleStatus": "Stable", + "maxCapacity": 3, + "modelCatalogAssetId": "azureml://registries/azureml-meta/models/Llama-3.2-90B-Vision-Instruct/versions/2", + "systemData": { + "createdAt": "2024-10-01T00:00:00Z", + "createdBy": "Microsoft", + "createdByType": "Application", + "lastModifiedAt": "2025-04-16T04:45:33.9367873Z", + "lastModifiedBy": "MaaSModelConverter", + "lastModifiedByType": "Application" + }, + "version": "2" + }, + { + "name": "gpt-4o", + "format": "OpenAI", + "capabilities": { + "chat": "true", + "completion": "true", + "fineTune": "false", + "functionCalling": "true", + "inference": "true", + "vision": "true" + }, + "finetuneCapabilities": { + "chat": "true", + "completion": "true", + "fineTune": "true", + "inference": "true", + "scaleType": "Manual" + }, + "lifecycleStatus": "GenerallyAvailable", + "maxCapacity": 50, + "modelCatalogAssetId": "azureml://registries/azure-openai/models/gpt-4o/versions/2024-08-06", + "systemData": { + "createdAt": "2024-08-06T00:00:00Z", + "createdBy": "Microsoft", + "createdByType": "Application", + "lastModifiedAt": "2024-11-01T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedByType": "Application" + }, + "version": "2024-08-06" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListAccountsByResourceGroup.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListAccountsByResourceGroup.json new file mode 100644 index 000000000000..4407e4ce97eb --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListAccountsByResourceGroup.json @@ -0,0 +1,52 @@ +{ + "operationId": "Accounts_ListByResourceGroup", + "parameters": { + "api-version": "2026-05-01", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List Accounts by Resource Group", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myAccount", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount", + "kind": "Emotion", + "location": "westus", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "F0" + }, + "tags": { + "ExpiredDate": "2017/09/01", + "Owner": "felixwa" + } + }, + { + "name": "TestPropertyWU2", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-07T04%3A32%3A38.9187216Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/TestPropertyWU2", + "kind": "Face", + "location": "westus", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/face/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + }, + "tags": {} + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListAccountsBySubscription.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListAccountsBySubscription.json new file mode 100644 index 000000000000..84c7a918f8c5 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListAccountsBySubscription.json @@ -0,0 +1,79 @@ +{ + "operationId": "Accounts_List", + "parameters": { + "api-version": "2026-05-01", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List Accounts by Subscription", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "bingSearch", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-03-27T11%3A19%3A08.762494Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch", + "kind": "Bing.Search", + "location": "global", + "properties": { + "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S1" + } + }, + { + "name": "CrisProd", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-03-31T08%3A57%3A07.4499566Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/CrisProd", + "kind": "CRIS", + "location": "westus", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/sts/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + }, + "tags": { + "can't delete it successfully": "v-yunjin" + } + }, + { + "name": "rayrptest0308", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-03-27T11%3A15%3A23.5232645Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/rayrptest0308", + "kind": "Face", + "location": "westus", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/face/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + }, + { + "name": "raytest02", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-04T02%3A07%3A07.3957572Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/raytest02", + "kind": "Emotion", + "location": "westus", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListBlocklistItems.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListBlocklistItems.json new file mode 100644 index 000000000000..930cd813c2dd --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListBlocklistItems.json @@ -0,0 +1,35 @@ +{ + "operationId": "RaiBlocklistItems_List", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiBlocklistName": "raiBlocklistName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListBlocklistItems", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "raiBlocklistItemName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName", + "properties": { + "isRegex": false, + "pattern": "Pattern To Block" + } + }, + { + "name": "raiBlocklistItemName2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName2", + "properties": { + "isRegex": false, + "pattern": "Another Pattern To Block" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListBlocklists.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListBlocklists.json new file mode 100644 index 000000000000..87e6694809b0 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListBlocklists.json @@ -0,0 +1,25 @@ +{ + "operationId": "RaiBlocklists_List", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListBlocklists", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "raiBlocklistName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName", + "properties": { + "description": "This is a sample blocklist" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListCommitmentPlans.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListCommitmentPlans.json new file mode 100644 index 000000000000..c3b29f0df32b --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListCommitmentPlans.json @@ -0,0 +1,31 @@ +{ + "operationId": "CommitmentPlans_List", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "ListCommitmentPlans", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/accounts/commitmentPlans", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/commitmentPlans/commitmentPlanName", + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "Speech2Text" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListCommitmentTiers.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListCommitmentTiers.json new file mode 100644 index 000000000000..42c7b033a453 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListCommitmentTiers.json @@ -0,0 +1,30 @@ +{ + "operationId": "CommitmentTiers_List", + "parameters": { + "api-version": "2026-05-01", + "location": "location", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "ListCommitmentTiers", + "responses": { + "200": { + "body": { + "value": [ + { + "cost": {}, + "hostingModel": "Web", + "kind": "TextAnalytics", + "planType": "TA", + "quota": { + "quantity": 1000000, + "unit": "Transaction" + }, + "skuName": "S", + "tier": "T1" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListDefenderForAISetting.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListDefenderForAISetting.json new file mode 100644 index 000000000000..5fa7f8e8d254 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListDefenderForAISetting.json @@ -0,0 +1,35 @@ +{ + "operationId": "DefenderForAISettings_List", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListDefenderForAISetting", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdAt": "2022-04-03T04:41:33.937Z", + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListDeletedAccountsBySubscription.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListDeletedAccountsBySubscription.json new file mode 100644 index 000000000000..8cabb834aee5 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListDeletedAccountsBySubscription.json @@ -0,0 +1,79 @@ +{ + "operationId": "DeletedAccounts_List", + "parameters": { + "api-version": "2026-05-01", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List Deleted Accounts by Subscription", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "bingSearch", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-03-27T11%3A19%3A08.762494Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch", + "kind": "Bing.Search", + "location": "global", + "properties": { + "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S1" + } + }, + { + "name": "CrisProd", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-03-31T08%3A57%3A07.4499566Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/CrisProd", + "kind": "CRIS", + "location": "westus", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/sts/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + }, + "tags": { + "can't delete it successfully": "v-yunjin" + } + }, + { + "name": "rayrptest0308", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-03-27T11%3A15%3A23.5232645Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/rayrptest0308", + "kind": "Face", + "location": "westus", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/face/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + }, + { + "name": "raytest02", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-04T02%3A07%3A07.3957572Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/raytest02", + "kind": "Emotion", + "location": "westus", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListDeploymentSkus.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListDeploymentSkus.json new file mode 100644 index 000000000000..420b6cf7cd65 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListDeploymentSkus.json @@ -0,0 +1,36 @@ +{ + "operationId": "Deployments_ListSkus", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "deploymentName": "deploymentName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListDeploymentSkus", + "responses": { + "200": { + "body": { + "value": [ + { + "capacity": { + "default": 100, + "allowedValues": [ + 100, + 200 + ], + "maximum": 1000, + "minimum": 100, + "step": 100 + }, + "resourceType": "Microsoft.CognitiveServices/accounts/deployments", + "sku": { + "name": "Standard", + "capacity": 1 + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListDeployments.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListDeployments.json new file mode 100644 index 000000000000..58bee469e165 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListDeployments.json @@ -0,0 +1,37 @@ +{ + "operationId": "Deployments_List", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "ListDeployments", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "properties": { + "deploymentState": "Running", + "model": { + "name": "ada", + "format": "OpenAI", + "version": "1" + }, + "provisioningState": "Succeeded", + "serviceTier": "Default" + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListEncryptionScopes.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListEncryptionScopes.json new file mode 100644 index 000000000000..5b8adc7b8c0f --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListEncryptionScopes.json @@ -0,0 +1,43 @@ +{ + "operationId": "EncryptionScopes_List", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListEncryptionScopes", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "encryptionScopeName", + "type": "Microsoft.CognitiveServices/accounts/encryptionScopes", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName", + "properties": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "identityClientId": "00000000-0000-0000-0000-000000000000", + "keyName": "DevKeyWestUS2", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95" + }, + "provisioningState": "Succeeded", + "state": "Enabled" + }, + "systemData": { + "createdAt": "2023-06-08T06:35:08.0662558Z", + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2023-06-08T06:35:08.0662558Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListKeys.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListKeys.json new file mode 100644 index 000000000000..c80a7e64645b --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListKeys.json @@ -0,0 +1,18 @@ +{ + "operationId": "Accounts_ListKeys", + "parameters": { + "accountName": "myAccount", + "api-version": "2026-05-01", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List Keys", + "responses": { + "200": { + "body": { + "key1": "KEY1", + "key2": "KEY2" + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListLocationBasedModelCapacities.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListLocationBasedModelCapacities.json new file mode 100644 index 000000000000..7fc4588e443e --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListLocationBasedModelCapacities.json @@ -0,0 +1,36 @@ +{ + "operationId": "LocationBasedModelCapacities_List", + "parameters": { + "api-version": "2026-05-01", + "location": "WestUS", + "modelFormat": "OpenAI", + "modelName": "ada", + "modelVersion": "1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListLocationBasedModelCapacities", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard", + "type": "Microsoft.CognitiveServices/locations/models/skuCapacities", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/models/OpenAI.ada.1/skuCapacities/Standard", + "location": "WestUS", + "properties": { + "availableCapacity": 300, + "availableFinetuneCapacity": 20, + "model": { + "name": "ada", + "format": "OpenAI", + "version": "1" + }, + "skuName": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListLocationModels.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListLocationModels.json new file mode 100644 index 000000000000..6a44af8050ab --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListLocationModels.json @@ -0,0 +1,292 @@ +{ + "operationId": "Models_List", + "parameters": { + "api-version": "2026-05-01", + "location": "WestUS", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListLocationModels", + "responses": { + "200": { + "body": { + "value": [ + { + "kind": "OpenAI", + "model": { + "name": "ada", + "format": "OpenAI", + "capabilities": { + "FineTuneTokensMaxValue": "2000000000", + "FineTuneTokensMaxValuePerExample": "4096", + "completion": "true", + "inference": "false", + "scaleType": "Manual", + "search": "true" + }, + "deprecation": { + "deprecationStatus": "Planned", + "fineTune": "2024-06-14T00:00:00Z", + "inference": "2024-06-14T00:00:00Z" + }, + "lifecycleStatus": "Legacy", + "maxCapacity": 3, + "skus": [ + { + "name": "provisioned", + "capacity": { + "default": 100, + "maximum": 1000, + "minimum": 100, + "step": 100 + }, + "usageName": "OpenAI.Provisioned.Class1" + } + ], + "systemData": { + "createdAt": "2021-10-07T00:00:00Z", + "createdBy": "Microsoft", + "lastModifiedAt": "2021-10-07T00:00:00Z", + "lastModifiedBy": "Microsoft" + }, + "version": "1" + }, + "skuName": "S0" + }, + { + "kind": "AIServices", + "model": { + "name": "dall-e-3", + "format": "OpenAI", + "capabilities": { + "imageGenerations": "true", + "inference": "true" + }, + "deprecation": { + "deprecationStatus": "Tentative", + "inference": "2025-06-30T00:00:00Z" + }, + "isDefaultVersion": true, + "lifecycleStatus": "GenerallyAvailable", + "maxCapacity": 2, + "modelCatalogAssetId": "azureml://registries/azure-openai/models/dall-e-3/versions/3.0", + "skus": [ + { + "name": "Provisioned", + "capacity": { + "default": 300, + "maximum": 60000, + "minimum": 300, + "step": 100 + }, + "deprecationDate": "2025-09-30T00:00:00Z", + "usageName": "OpenAI.Provisioned.Dalle" + } + ], + "systemData": { + "createdAt": "2023-08-11T00:00:00Z", + "createdBy": "Microsoft", + "lastModifiedAt": "2023-08-11T00:00:00Z", + "lastModifiedBy": "Microsoft" + }, + "version": "3.0" + }, + "skuName": "S0" + }, + { + "kind": "OpenAI", + "model": { + "name": "gpt-35-turbo", + "format": "OpenAI", + "capabilities": { + "chatCompletion": "true", + "completion": "true", + "maxTotalToken": "4096", + "scaleType": "Manual,Standard" + }, + "deprecation": { + "deprecationStatus": "Planned", + "inference": "2025-04-30T00:00:00Z" + }, + "isDefaultVersion": false, + "lifecycleStatus": "Deprecated", + "maxCapacity": 9, + "skus": [ + { + "name": "Standard", + "capacity": { + "default": 120, + "maximum": 1000000 + }, + "deprecationDate": "2025-02-13T00:00:00Z", + "usageName": "OpenAI.Standard.gpt-35-turbo" + }, + { + "name": "Provisioned", + "capacity": { + "default": 300, + "maximum": 30000, + "minimum": 300, + "step": 100 + }, + "deprecationDate": "2025-05-15T00:00:00Z", + "usageName": "OpenAI.Provisioned.gpt-35-turbo" + } + ], + "systemData": { + "createdAt": "2023-03-09T00:00:00Z", + "createdBy": "Microsoft", + "createdByType": "Application", + "lastModifiedAt": "2023-07-06T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedByType": "Application" + }, + "version": "0301" + }, + "skuName": "S0" + }, + { + "kind": "OpenAI", + "model": { + "name": "gpt-4o", + "format": "OpenAI", + "capabilities": { + "chat": "true", + "completion": "true", + "fineTune": "false", + "inference": "true", + "scaleType": "Manual,Provisioned", + "vision": "true" + }, + "deprecation": { + "deprecationStatus": "Tentative", + "inference": "2025-09-15T00:00:00Z" + }, + "lifecycleStatus": "Deprecating", + "maxCapacity": 50, + "modelCatalogAssetId": "azureml://registries/azure-openai/models/gpt-4o/versions/2024-05-13", + "replacementConfig": { + "autoUpgradeStartDate": "2025-03-26T07:00:00Z", + "targetModelName": "gpt-4.1", + "targetModelVersion": "2025-04-14", + "upgradeOnExpiryLeadTimeDays": 7 + }, + "skus": [ + { + "name": "provisioned", + "capacity": { + "default": 100, + "maximum": 2000, + "minimum": 50, + "step": 50 + }, + "usageName": "OpenAI.Provisioned.GPT4o" + } + ], + "systemData": { + "createdAt": "2024-05-13T00:00:00Z", + "createdBy": "Microsoft", + "lastModifiedAt": "2024-12-15T00:00:00Z", + "lastModifiedBy": "Microsoft" + }, + "version": "2024-05-13" + }, + "skuName": "S0" + }, + { + "kind": "AIServices", + "model": { + "name": "Llama-3.2-90B-Vision-Instruct", + "format": "Meta", + "capabilities": { + "chatCompletion": "true" + }, + "deprecation": { + "inference": "2099-12-31T00:00:00Z" + }, + "isDefaultVersion": false, + "lifecycleStatus": "Stable", + "maxCapacity": 3, + "modelCatalogAssetId": "azureml://registries/azureml-meta/models/Llama-3.2-90B-Vision-Instruct/versions/2", + "skus": [ + { + "name": "GlobalStandard", + "capacity": { + "default": 1, + "maximum": 1 + }, + "usageName": "AIServices.GlobalStandard.MaaS" + } + ], + "systemData": { + "createdAt": "2024-10-01T00:00:00Z", + "createdBy": "Microsoft", + "createdByType": "Application", + "lastModifiedAt": "2025-04-16T04:45:33.9367873Z", + "lastModifiedBy": "MaaSModelConverter", + "lastModifiedByType": "Application" + }, + "version": "2" + }, + "skuName": "S0" + }, + { + "kind": "OpenAI", + "model": { + "name": "gpt-4o", + "format": "OpenAI", + "capabilities": { + "chat": "true", + "completion": "true", + "fineTune": "false", + "functionCalling": "true", + "inference": "true", + "scaleType": "Manual,Standard,Provisioned", + "vision": "true" + }, + "finetuneCapabilities": { + "chat": "true", + "completion": "true", + "fineTune": "true", + "inference": "true", + "scaleType": "Manual" + }, + "lifecycleStatus": "GenerallyAvailable", + "maxCapacity": 50, + "modelCatalogAssetId": "azureml://registries/azure-openai/models/gpt-4o/versions/2024-08-06", + "skus": [ + { + "name": "Standard", + "capacity": { + "default": 10, + "maximum": 100, + "minimum": 1, + "step": 1 + }, + "usageName": "OpenAI.Standard.GPT4o" + }, + { + "name": "provisioned", + "capacity": { + "default": 100, + "maximum": 2000, + "minimum": 50, + "step": 50 + }, + "usageName": "OpenAI.Provisioned.GPT4o" + } + ], + "systemData": { + "createdAt": "2024-08-06T00:00:00Z", + "createdBy": "Microsoft", + "lastModifiedAt": "2024-11-01T00:00:00Z", + "lastModifiedBy": "Microsoft" + }, + "version": "2024-08-06" + }, + "skuName": "S0" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListModelCapacities.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListModelCapacities.json new file mode 100644 index 000000000000..3a0bd36593b1 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListModelCapacities.json @@ -0,0 +1,35 @@ +{ + "operationId": "ModelCapacities_List", + "parameters": { + "api-version": "2026-05-01", + "modelFormat": "OpenAI", + "modelName": "ada", + "modelVersion": "1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListModelCapacities", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard", + "type": "Microsoft.CognitiveServices/locations/models/skuCapacities", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/models/OpenAI.ada.1/skuCapacities/Standard", + "location": "WestUS", + "properties": { + "availableCapacity": 300, + "availableFinetuneCapacity": 20, + "model": { + "name": "ada", + "format": "OpenAI", + "version": "1" + }, + "skuName": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListNetworkSecurityPerimeterConfigurations.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListNetworkSecurityPerimeterConfigurations.json new file mode 100644 index 000000000000..6a08b9803086 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListNetworkSecurityPerimeterConfigurations.json @@ -0,0 +1,51 @@ +{ + "operationId": "NetworkSecurityPerimeterConfigurations_List", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListNetworkSecurityPerimeterConfigurations", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "networkSecurityPerimeterConfigurationName", + "type": "Microsoft.CognitiveServices/accounts/networkSecurityPerimeterConfigurations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/networkSecurityPerimeterConfigurations/config1", + "properties": { + "networkSecurityPerimeter": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.Network/networkSecurityPerimeters/perimeter", + "location": "East US", + "perimeterGuid": "00000000-0000-0000-0000-000000000000" + }, + "profile": { + "name": "profileName", + "accessRules": [ + { + "name": "ruleName", + "properties": { + "addressPrefixes": [ + "148.0.0.0/8", + "152.4.6.0/24" + ], + "direction": "Inbound" + } + } + ], + "accessRulesVersion": 1 + }, + "provisioningState": "Succeeded", + "resourceAssociation": { + "name": "associationName", + "accessMode": "Enforced" + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListPrivateEndpointConnections.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListPrivateEndpointConnections.json new file mode 100644 index 000000000000..cf9541b23dd8 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListPrivateEndpointConnections.json @@ -0,0 +1,33 @@ +{ + "operationId": "PrivateEndpointConnections_List", + "parameters": { + "accountName": "sto2527", + "api-version": "2026-05-01", + "resourceGroupName": "res6977", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "GetPrivateEndpointConnection", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "description": "Auto-Approved", + "actionsRequired": "None", + "status": "Approved" + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListPrivateLinkResources.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListPrivateLinkResources.json new file mode 100644 index 000000000000..6b389a785029 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListPrivateLinkResources.json @@ -0,0 +1,32 @@ +{ + "operationId": "PrivateLinkResources_List", + "parameters": { + "accountName": "sto2527", + "api-version": "2026-05-01", + "resourceGroupName": "res6977", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "ListPrivateLinkResources", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "blob", + "type": "Microsoft.CognitiveServices/accounts/privateLinkResources", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res6977/providers/Microsoft.CognitiveServices/accounts/sto2527/privateLinkResources/account", + "properties": { + "groupId": "account", + "requiredMembers": [ + "default" + ], + "requiredZoneNames": [ + "privatelink.cognitiveservices.azure.com" + ] + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListProjects.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListProjects.json new file mode 100644 index 000000000000..dae9182be365 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListProjects.json @@ -0,0 +1,57 @@ +{ + "operationId": "Projects_List", + "parameters": { + "accountName": "myAccount", + "api-version": "2026-05-01", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List Project", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myProject", + "type": "Microsoft.CognitiveServices/accounts/projects", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount/projects/myProject", + "location": "westus", + "properties": { + "description": "This is my project 1", + "displayName": "myProject1", + "endpoints": { + "OpenAI Dall-E API": "https://customSubDomainName.openai.azure.com/", + "OpenAI Language Model Instance API": "https://customSubDomainName.openai.azure.com/" + }, + "isDefault": true, + "provisioningState": "Succeeded" + }, + "tags": { + "ExpiredDate": "2017/09/01", + "Owner": "felixwa" + } + }, + { + "name": "myProject-2", + "type": "Microsoft.CognitiveServices/accounts/projects", + "etag": "W/\"datetime'2017-04-07T04%3A32%3A38.9187216Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount/projects/myProject-2", + "location": "westus", + "properties": { + "description": "This is my project 2", + "displayName": "myProject2", + "endpoints": { + "OpenAI Dall-E API": "https://customSubDomainName2.openai.azure.com/", + "OpenAI Language Model Instance API": "https://customSubDomainName2.openai.azure.com/" + }, + "isDefault": false, + "provisioningState": "Succeeded" + }, + "tags": {} + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListQuotaTiers.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListQuotaTiers.json new file mode 100644 index 000000000000..33d983056d18 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListQuotaTiers.json @@ -0,0 +1,31 @@ +{ + "operationId": "QuotaTiers_ListBySubscription", + "parameters": { + "api-version": "2026-05-01", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List the Quota Tier for a subscription", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.CognitiveServices/quotaTiers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/quotaTiers/default", + "properties": { + "assignmentDate": "2025-06-09T18:13:29.389Z", + "currentTierName": "Free-Tier", + "tierUpgradeEligibilityInfo": { + "nextTierName": "Tier-1", + "upgradeApplicableDate": "2025-06-15T18:13:29.389Z", + "upgradeAvailabilityStatus": "Available" + }, + "tierUpgradePolicy": "OnceUpgradeIsAvailable" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListRaiContentFilters.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListRaiContentFilters.json new file mode 100644 index 000000000000..17ce6d2f2356 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListRaiContentFilters.json @@ -0,0 +1,102 @@ +{ + "operationId": "RaiContentFilters_List", + "parameters": { + "api-version": "2026-05-01", + "location": "WestUS", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListRaiContentFilters", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Hate", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Hate", + "properties": { + "name": "Hate", + "isMultiLevelFilter": true + } + }, + { + "name": "Sexual", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Sexual", + "properties": { + "name": "Sexual", + "isMultiLevelFilter": true + } + }, + { + "name": "Violence", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Violence", + "properties": { + "name": "Violence", + "isMultiLevelFilter": true + } + }, + { + "name": "Selfharm", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Selfharm", + "properties": { + "name": "Selfharm", + "isMultiLevelFilter": true + } + }, + { + "name": "Jailbreak", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Jailbreak", + "properties": { + "name": "Jailbreak", + "isMultiLevelFilter": false, + "source": "Prompt" + } + }, + { + "name": "ProtectedMaterialText", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/ProtectedMaterialText", + "properties": { + "name": "Protected Material Text", + "isMultiLevelFilter": false, + "source": "Completion" + } + }, + { + "name": "ProtectedMaterialCode", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/ProtectedMaterialCode", + "properties": { + "name": "Protected Material Code", + "isMultiLevelFilter": false, + "source": "Completion" + } + }, + { + "name": "Profanity", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Profanity", + "properties": { + "name": "Profanity", + "isMultiLevelFilter": false + } + }, + { + "name": "IndirectAttack", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/IndirectAttack", + "properties": { + "name": "Indirect Attack", + "isMultiLevelFilter": false, + "source": "Prompt" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListRaiExternalSafetyProviders.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListRaiExternalSafetyProviders.json new file mode 100644 index 000000000000..3b1555af1a55 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListRaiExternalSafetyProviders.json @@ -0,0 +1,61 @@ +{ + "operationId": "RaiExternalSafetyProviders_List", + "parameters": { + "api-version": "2026-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListRaiExternalSafetyProviders", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "purview", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/raiExternalSafetyProviders/purview", + "properties": { + "createdAt": "2025-07-01T00:00:00Z", + "keyVaultUri": "https://example.vault.azure.net", + "lastModifiedAt": "2025-07-02T00:00:00Z", + "managedIdentity": "00000000-0000-0000-0000-000000000000", + "mode": "sync", + "providerId": "00000000-0000-0000-0000-000000000000", + "providerName": "purview", + "secretName": "mySecretName", + "url": "https://example.webhook.endpoint" + } + }, + { + "name": "microsoftDefenderForCloud", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/raiExternalSafetyProviders/microsoftDefenderForCloud", + "properties": { + "createdAt": "2025-07-01T00:00:00Z", + "keyVaultUri": "https://example.vault.azure.net", + "lastModifiedAt": "2025-07-02T00:00:00Z", + "managedIdentity": "00000000-0000-0000-0000-000000000000", + "mode": "sync", + "providerId": "00000000-0000-0000-0000-000000000000", + "providerName": "microsoftDefenderForCloud", + "secretName": "mySecretName", + "url": "https://example.webhook.endpoint" + } + }, + { + "name": "sampleSafetyProvider", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/raiExternalSafetyProviders/sampleSafetyProvider", + "properties": { + "createdAt": "2025-07-01T00:00:00Z", + "keyVaultUri": "https://example.vault.azure.net", + "lastModifiedAt": "2025-07-02T00:00:00Z", + "managedIdentity": "00000000-0000-0000-0000-000000000000", + "mode": "sync", + "providerId": "00000000-0000-0000-0000-000000000000", + "providerName": "sampleSafetyProvider", + "secretName": "mySecretName", + "url": "https://example.webhook.endpoint" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListRaiPolicies.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListRaiPolicies.json new file mode 100644 index 000000000000..9b02a035791b --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListRaiPolicies.json @@ -0,0 +1,108 @@ +{ + "operationId": "RaiPolicies_List", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListRaiPolicies", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "contentFilters": [ + { + "name": "Hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Jailbreak", + "blocking": true, + "enabled": true, + "source": "Prompt" + }, + { + "name": "Protected Material Text", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Protected Material Code", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Profanity", + "blocking": true, + "enabled": true, + "source": "Prompt" + } + ], + "mode": "Asynchronous_filter" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListRaiToolLabels.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListRaiToolLabels.json new file mode 100644 index 000000000000..a094f06b0950 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListRaiToolLabels.json @@ -0,0 +1,44 @@ +{ + "operationId": "RaiToolLabels_List", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListRaiToolLabels", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "raiIfcToolLabelName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiIfcToolLabels/raiIfcToolLabelName", + "properties": { + "accountScope": { + "labelValues": { + "confidentiality": "low" + } + }, + "projectScopes": [ + { + "labelValues": { + "confidentiality": "low" + }, + "project": "hualiang-project" + }, + { + "labelValues": { + "confidentiality": "low" + }, + "project": "sahana-project" + } + ], + "toolConnectionName": "Web_Search" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListRaiTopics.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListRaiTopics.json new file mode 100644 index 000000000000..58599ece5d9e --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListRaiTopics.json @@ -0,0 +1,31 @@ +{ + "operationId": "RaiTopics_List", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListRaiTopics", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "raiTopicName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiTopics/raiTopicName", + "properties": { + "description": "This is a sample topic.", + "createdAt": "2025-07-01T00:00:00Z", + "lastModifiedAt": "2025-07-02T00:00:00Z", + "sampleBlobUrl": "https://example.blob.core.windows.net/sampleblob", + "status": "Succeeded", + "topicId": "00000000-0000-0000-0000-000000000000", + "topicName": "raiTopicName" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListSharedCommitmentPlanAssociations.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListSharedCommitmentPlanAssociations.json new file mode 100644 index 000000000000..e10b66cae90f --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListSharedCommitmentPlanAssociations.json @@ -0,0 +1,26 @@ +{ + "operationId": "CommitmentPlans_ListAssociations", + "parameters": { + "api-version": "2026-05-01", + "commitmentPlanName": "commitmentPlanName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "ListCommitmentPlans", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "accountAssociationName", + "type": "Microsoft.CognitiveServices/commitmentPlans/accountAssociations", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName/accountAssociations/accountAssociationName", + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListSharedCommitmentPlansByResourceGroup.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListSharedCommitmentPlansByResourceGroup.json new file mode 100644 index 000000000000..fd4b906b154f --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListSharedCommitmentPlansByResourceGroup.json @@ -0,0 +1,36 @@ +{ + "operationId": "CommitmentPlans_ListPlansByResourceGroup", + "parameters": { + "api-version": "2026-05-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List Commitment Plans by Resource Group", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "kind": "SpeechServices", + "location": "West US", + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "STT", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListSharedCommitmentPlansBySubscription.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListSharedCommitmentPlansBySubscription.json new file mode 100644 index 000000000000..acd7faa022b9 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListSharedCommitmentPlansBySubscription.json @@ -0,0 +1,35 @@ +{ + "operationId": "CommitmentPlans_ListPlansBySubscription", + "parameters": { + "api-version": "2026-05-01", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List Accounts by Subscription", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "kind": "SpeechServices", + "location": "West US", + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "STT", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListSkus.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListSkus.json new file mode 100644 index 000000000000..31b0718ac2fc --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListSkus.json @@ -0,0 +1,32 @@ +{ + "operationId": "Accounts_ListSkus", + "parameters": { + "accountName": "myAccount", + "api-version": "2026-05-01", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List SKUs", + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.CognitiveServices/accounts", + "sku": { + "name": "F0", + "tier": "Free" + } + }, + { + "resourceType": "Microsoft.CognitiveServices/accounts", + "sku": { + "name": "S0", + "tier": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListUsages.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListUsages.json new file mode 100644 index 000000000000..327b6dc86f62 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ListUsages.json @@ -0,0 +1,26 @@ +{ + "operationId": "Usages_List", + "parameters": { + "api-version": "2026-05-01", + "location": "WestUS", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Get Usages", + "responses": { + "200": { + "body": { + "value": [ + { + "name": { + "localizedValue": "Cognitive Services total account limit", + "value": "AccountCount" + }, + "currentValue": 3, + "limit": 200, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/createOrUpdateManagedNetworkV2.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/createOrUpdateManagedNetworkV2.json new file mode 100644 index 000000000000..20f1b6dca6a1 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/createOrUpdateManagedNetworkV2.json @@ -0,0 +1,59 @@ +{ + "operationId": "ManagedNetworkSettings_Put", + "parameters": { + "accountName": "cognitive-account-name", + "api-version": "2026-05-01", + "body": { + "properties": { + "managedNetwork": { + "firewallSku": "Standard", + "isolationMode": "AllowOnlyApprovedOutbound", + "outboundRules": { + "rule_name_1": { + "type": "FQDN", + "category": "UserDefined", + "destination": "destination_endpoint" + } + } + } + } + }, + "managedNetworkName": "default", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Put ManagedNetworkSettings", + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.CognitiveServices/accounts/managedNetworks", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default", + "properties": { + "managedNetwork": { + "firewallPublicIpAddress": "22.22.131.49", + "firewallSku": "Standard", + "isolationMode": "AllowOnlyApprovedOutbound", + "networkId": "00000000-1111-2222-3333-444444444444", + "outboundRules": { + "rule_name_1": { + "type": "FQDN", + "category": "UserDefined", + "destination": "destination_endpoint", + "status": "Active" + } + }, + "provisioningState": "Succeeded" + }, + "provisioningState": "Succeeded" + } + }, + "headers": {} + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/createOrUpdateRuleV2.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/createOrUpdateRuleV2.json new file mode 100644 index 000000000000..2f36a3f6a0ea --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/createOrUpdateRuleV2.json @@ -0,0 +1,41 @@ +{ + "operationId": "OutboundRule_CreateOrUpdate", + "parameters": { + "accountName": "cognitive-account-name", + "api-version": "2026-05-01", + "body": { + "properties": { + "type": "FQDN", + "category": "UserDefined", + "destination": "destination_endpoint", + "status": "Active" + } + }, + "managedNetworkName": "default", + "resourceGroupName": "test-rg", + "ruleName": "rule_name_1", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "CreateOrUpdate OutboundRule", + "responses": { + "200": { + "body": { + "name": "rule_name_1", + "type": "accounts/outboundRules", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default/outboundRules/rule_name_1", + "properties": { + "type": "FQDN", + "category": "UserDefined", + "destination": "destination_endpoint", + "status": "Active" + } + }, + "headers": {} + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/deleteManagedNetworkV2.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/deleteManagedNetworkV2.json new file mode 100644 index 000000000000..602c7990be12 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/deleteManagedNetworkV2.json @@ -0,0 +1,20 @@ +{ + "operationId": "ManagedNetworkSettings_Delete", + "parameters": { + "accountName": "cognitive-account-name", + "api-version": "2026-05-01", + "managedNetworkName": "default", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Delete ManagedNetworkSettings", + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.CognitiveServices/locations/westus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2026-05-01", + "Retry-After": "10" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/deleteRuleV2.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/deleteRuleV2.json new file mode 100644 index 000000000000..f83b894a9006 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/deleteRuleV2.json @@ -0,0 +1,21 @@ +{ + "operationId": "OutboundRule_Delete", + "parameters": { + "accountName": "cognitive-account-name", + "api-version": "2026-05-01", + "managedNetworkName": "default", + "resourceGroupName": "test-rg", + "ruleName": "rule-name", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Delete OutboundRule", + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.CognitiveServices/locations/westus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2026-05-01", + "Retry-After": "10" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/getManagedNetworkV2.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/getManagedNetworkV2.json new file mode 100644 index 000000000000..55d7566b76e5 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/getManagedNetworkV2.json @@ -0,0 +1,39 @@ +{ + "operationId": "ManagedNetworkSettings_Get", + "parameters": { + "accountName": "cognitive-account-name", + "api-version": "2026-05-01", + "managedNetworkName": "default", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Get ManagedNetworkSettings", + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.CognitiveServices/accounts/managedNetworks", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default", + "properties": { + "managedNetwork": { + "firewallPublicIpAddress": "22.22.131.49", + "firewallSku": "Standard", + "isolationMode": "AllowOnlyApprovedOutbound", + "networkId": "00000000-1111-2222-3333-444444444444", + "outboundRules": { + "rule_name_1": { + "type": "FQDN", + "category": "UserDefined", + "destination": "destination_endpoint", + "status": "Active" + } + }, + "provisioningState": "Succeeded" + }, + "provisioningState": "Succeeded" + } + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/getRuleV2.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/getRuleV2.json new file mode 100644 index 000000000000..b1dc41f005ba --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/getRuleV2.json @@ -0,0 +1,28 @@ +{ + "operationId": "OutboundRule_Get", + "parameters": { + "accountName": "cognitive-account-name", + "api-version": "2026-05-01", + "managedNetworkName": "default", + "resourceGroupName": "test-rg", + "ruleName": "name_of_the_fqdn_rule", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Get OutboundRule", + "responses": { + "200": { + "body": { + "name": "rule_name_1", + "type": "accounts/outboundRules", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default/outboundRules/rule_name_1", + "properties": { + "type": "FQDN", + "category": "UserDefined", + "destination": "destination_of_the_fqdn_rule", + "status": "Active" + } + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/listManagedNetworkV2.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/listManagedNetworkV2.json new file mode 100644 index 000000000000..d5b180cafc7a --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/listManagedNetworkV2.json @@ -0,0 +1,43 @@ +{ + "operationId": "ManagedNetworkSettings_List", + "parameters": { + "accountName": "cognitive-account-name", + "api-version": "2026-05-01", + "managedNetworkName": "default", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List ManagedNetworkSettings", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.CognitiveServices/accounts/managedNetworks", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default", + "properties": { + "managedNetwork": { + "firewallPublicIpAddress": "22.22.131.49", + "firewallSku": "Standard", + "isolationMode": "AllowOnlyApprovedOutbound", + "networkId": "00000000-1111-2222-3333-444444444444", + "outboundRules": { + "rule_name_1": { + "type": "FQDN", + "category": "UserDefined", + "destination": "destination_endpoint", + "status": "Active" + } + }, + "provisioningState": "Succeeded" + }, + "provisioningState": "Succeeded" + } + } + ] + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/listRuleV2.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/listRuleV2.json new file mode 100644 index 000000000000..4d78db56bccd --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/listRuleV2.json @@ -0,0 +1,44 @@ +{ + "operationId": "OutboundRule_List", + "parameters": { + "accountName": "cognitive-account-name", + "api-version": "2026-05-01", + "managedNetworkName": "default", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List OutboundRules", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule_name_1", + "type": "accounts/outboundRules", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default/outboundRules/rule_name_1", + "properties": { + "type": "FQDN", + "category": "Required", + "destination": "destination_of_the_fqdn_rule", + "errorInformation": "Error message", + "status": "Inactive" + } + }, + { + "name": "rule_name_2", + "type": "accounts/outboundRules", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default/outboundRules/rule_name_2", + "properties": { + "type": "FQDN", + "category": "Required", + "destination": "destination_of_the_fqdn_rule", + "errorInformation": "Error message", + "status": "Inactive" + } + } + ] + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/patchManagedNetworkV2.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/patchManagedNetworkV2.json new file mode 100644 index 000000000000..0a017a56665f --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/patchManagedNetworkV2.json @@ -0,0 +1,59 @@ +{ + "operationId": "ManagedNetworkSettings_Patch", + "parameters": { + "accountName": "cognitive-account-name", + "api-version": "2026-05-01", + "body": { + "properties": { + "managedNetwork": { + "firewallSku": "Standard", + "isolationMode": "AllowOnlyApprovedOutbound", + "outboundRules": { + "rule_name_1": { + "type": "FQDN", + "category": "UserDefined", + "destination": "destination_endpoint" + } + } + } + } + }, + "managedNetworkName": "default", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Patch ManagedNetworkSettings", + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.CognitiveServices/accounts/managedNetworks", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default", + "properties": { + "managedNetwork": { + "firewallPublicIpAddress": "22.22.131.49", + "firewallSku": "Standard", + "isolationMode": "AllowOnlyApprovedOutbound", + "networkId": "00000000-1111-2222-3333-444444444444", + "outboundRules": { + "rule_name_1": { + "type": "FQDN", + "category": "UserDefined", + "destination": "destination_endpoint", + "status": "Active" + } + }, + "provisioningState": "Succeeded" + }, + "provisioningState": "Succeeded" + } + }, + "headers": {} + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/postOutboundRulesV2.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/postOutboundRulesV2.json new file mode 100644 index 000000000000..ccfbc1032395 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/postOutboundRulesV2.json @@ -0,0 +1,49 @@ +{ + "operationId": "OutboundRules_Post", + "parameters": { + "accountName": "cognitive-account-name", + "api-version": "2026-05-01", + "body": { + "properties": { + "firewallSku": "Standard", + "isolationMode": "AllowOnlyApprovedOutbound", + "outboundRules": { + "rule_name_1": { + "type": "FQDN", + "category": "UserDefined", + "destination": "destination_endpoint" + } + } + } + }, + "managedNetworkName": "default", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Post OutboundRules", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule_name_1", + "type": "accounts/outboundRules", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default/outboundRules/rule_name_1", + "properties": { + "type": "FQDN", + "category": "Required", + "destination": "destination_of_the_fqdn_rule", + "status": "Active" + } + } + ] + }, + "headers": {} + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/provisionManagedNetwork.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/provisionManagedNetwork.json new file mode 100644 index 000000000000..435f0aff4174 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ManagedNetwork/provisionManagedNetwork.json @@ -0,0 +1,24 @@ +{ + "operationId": "ManagedNetworkProvisions_ProvisionManagedNetwork", + "parameters": { + "accountName": "cognitive-account-name", + "api-version": "2026-05-01", + "body": {}, + "managedNetworkName": "default", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Provision ManagedNetwork", + "responses": { + "200": { + "body": { + "status": "Active" + } + }, + "202": { + "headers": { + "Location": "location_url_to_poll_for_status" + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PauseDeployment.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PauseDeployment.json new file mode 100644 index 000000000000..e7eef89bdabc --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PauseDeployment.json @@ -0,0 +1,33 @@ +{ + "operationId": "Deployments_Pause", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "deploymentName": "deploymentName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "PauseDeployment", + "responses": { + "200": { + "body": { + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "properties": { + "deploymentState": "Paused", + "model": { + "name": "gpt-4", + "format": "OpenAI", + "version": "0613" + }, + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectCapabilityHost/createOrUpdate.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectCapabilityHost/createOrUpdate.json new file mode 100644 index 000000000000..2a15cb7f9e05 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectCapabilityHost/createOrUpdate.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "capabilityHost": { + "properties": { + "aiServicesConnections": [ + "aoai_connection" + ], + "storageConnections": [ + "blob_connection" + ], + "threadStorageConnections": [ + "aca_connection" + ], + "vectorStoreConnections": [ + "acs_connection" + ] + } + }, + "capabilityHostName": "capabilityHostName", + "projectName": "project-1", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "capabilityHostName", + "type": "Microsoft.CognitiveServices/accounts/projects/capabilityHosts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/capabilityHosts/capabilityHostName", + "properties": { + "aiServicesConnections": [ + "aoai_connection" + ], + "provisioningState": "Succeeded", + "storageConnections": [ + "blob_connection" + ], + "threadStorageConnections": [ + "aca_connection" + ], + "vectorStoreConnections": [ + "acs_connection" + ] + } + }, + "headers": {} + }, + "201": { + "body": { + "name": "capabilityHostName", + "type": "Microsoft.CognitiveServices/accounts/projects/capabilityHosts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/capabilityHosts/capabilityHostName", + "properties": { + "aiServicesConnections": [ + "aoai_connection" + ], + "provisioningState": "Succeeded", + "storageConnections": [ + "blob_connection" + ], + "threadStorageConnections": [ + "aca_connection" + ], + "vectorStoreConnections": [ + "acs_connection" + ] + } + }, + "headers": { + "Location": "example_location" + } + } + }, + "operationId": "ProjectCapabilityHosts_CreateOrUpdate", + "title": "CreateOrUpdate Project CapabilityHost." +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectCapabilityHost/delete.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectCapabilityHost/delete.json new file mode 100644 index 000000000000..40ecb4ee9cc5 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectCapabilityHost/delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "ProjectCapabilityHosts_Delete", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "capabilityHostName": "capabilityHostName", + "projectName": "project-1", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Delete Project CapabilityHost.", + "responses": { + "202": { + "headers": { + "Location": "location_header_to_poll" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectCapabilityHost/get.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectCapabilityHost/get.json new file mode 100644 index 000000000000..5b1f59643d4c --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectCapabilityHost/get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "capabilityHostName": "capabilityHostName", + "projectName": "project-1", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "capabilityHostName", + "type": "Microsoft.CognitiveServices/accounts/projects/capabilityHosts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/capabilityHosts/capabilityHostName", + "properties": { + "aiServicesConnections": [ + "aoai_connection" + ], + "provisioningState": "Succeeded", + "storageConnections": [ + "blob_connection" + ], + "threadStorageConnections": [ + "aca_connection" + ], + "vectorStoreConnections": [ + "acs_connection" + ] + } + }, + "headers": {} + } + }, + "operationId": "ProjectCapabilityHosts_Get", + "title": "Get Project CapabilityHost." +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectCapabilityHost/list.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectCapabilityHost/list.json new file mode 100644 index 000000000000..2e3e622f0c82 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectCapabilityHost/list.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "projectName": "project-1", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "capabilityHostName", + "type": "Microsoft.CognitiveServices/accounts/projects/capabilityHosts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/capabilityHosts/capabilityHostName", + "properties": { + "aiServicesConnections": [ + "aoai_connection" + ], + "provisioningState": "Succeeded", + "storageConnections": [ + "blob_connection" + ], + "threadStorageConnections": [ + "aca_connection" + ], + "vectorStoreConnections": [ + "acs_connection" + ] + } + } + ] + }, + "headers": {} + } + }, + "operationId": "ProjectCapabilityHosts_List", + "title": "List Project CapabilityHosts." +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectConnection/create.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectConnection/create.json new file mode 100644 index 000000000000..ce6d3b413571 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectConnection/create.json @@ -0,0 +1,35 @@ +{ + "operationId": "ProjectConnections_Create", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "connection": { + "properties": { + "authType": "None", + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[target url]" + } + }, + "connectionName": "connection-1", + "projectName": "project-1", + "resourceGroupName": "resourceGroup-1", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "CreateProjectConnection", + "responses": { + "200": { + "body": { + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/projects/connections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/connections/connection-1", + "properties": { + "authType": "None", + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[target url]" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectConnection/delete.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectConnection/delete.json new file mode 100644 index 000000000000..6722b8bd121d --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectConnection/delete.json @@ -0,0 +1,16 @@ +{ + "operationId": "ProjectConnections_Delete", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "connectionName": "connection-1", + "projectName": "project-1", + "resourceGroupName": "resourceGroup-1", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "DeleteProjectConnection", + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectConnection/get.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectConnection/get.json new file mode 100644 index 000000000000..04f7fa00aef2 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectConnection/get.json @@ -0,0 +1,27 @@ +{ + "operationId": "ProjectConnections_Get", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "connectionName": "connection-1", + "projectName": "project-1", + "resourceGroupName": "resourceGroup-1", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "GetProjectConnection", + "responses": { + "200": { + "body": { + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/projects/connections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/connections/connection-1", + "properties": { + "authType": "None", + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[target url]" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectConnection/list.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectConnection/list.json new file mode 100644 index 000000000000..bda2f1585fe4 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectConnection/list.json @@ -0,0 +1,42 @@ +{ + "operationId": "ProjectConnections_List", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "category": "ContainerRegistry", + "projectName": "project-1", + "resourceGroupName": "resourceGroup-1", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "target": "[target url]" + }, + "title": "ListProjectConnection", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/projects/connections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/connections/connection-1", + "properties": { + "authType": "PAT", + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[target url]" + } + }, + { + "name": "connection-2", + "type": "Microsoft.CognitiveServices/accounts/projects/connections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/connections/connection-2", + "properties": { + "authType": "PAT", + "category": "ContainerRegistry", + "target": "[target url]" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectConnection/update.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectConnection/update.json new file mode 100644 index 000000000000..abd64bf5f239 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ProjectConnection/update.json @@ -0,0 +1,42 @@ +{ + "operationId": "ProjectConnections_Update", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "connection": { + "properties": { + "authType": "AccessKey", + "category": "ADLSGen2", + "credentials": { + "accessKeyId": "some_string", + "secretAccessKey": "some_string" + }, + "expiryTime": "2020-01-01T00:00:00Z", + "metadata": {}, + "target": "some_string" + } + }, + "connectionName": "connection-1", + "projectName": "project-1", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "UpdateProjectConnection", + "responses": { + "200": { + "body": { + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/projects/connections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/connections/connection-1", + "properties": { + "authType": "AccessKey", + "category": "ADLSGen2", + "expiryTime": "2020-01-01T00:00:00Z", + "metadata": {}, + "target": "some_string" + } + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PurgeDeletedAccount.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PurgeDeletedAccount.json new file mode 100644 index 000000000000..88958409b3dd --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PurgeDeletedAccount.json @@ -0,0 +1,20 @@ +{ + "operationId": "DeletedAccounts_Purge", + "parameters": { + "accountName": "PropTest01", + "api-version": "2026-05-01", + "location": "westus", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Delete Account", + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutCommitmentPlan.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutCommitmentPlan.json new file mode 100644 index 000000000000..65698fc13a0e --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutCommitmentPlan.json @@ -0,0 +1,53 @@ +{ + "operationId": "CommitmentPlans_CreateOrUpdate", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "commitmentPlan": { + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "Speech2Text" + } + }, + "commitmentPlanName": "commitmentPlanName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "PutCommitmentPlan", + "responses": { + "200": { + "body": { + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/accounts/commitmentPlans", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/commitmentPlans/commitmentPlanName", + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "Speech2Text" + } + } + }, + "201": { + "body": { + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/accounts/commitmentPlans", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/commitmentPlans/commitmentPlanName", + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "Speech2Text" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutDefenderForAISetting.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutDefenderForAISetting.json new file mode 100644 index 000000000000..c8cd2e1928f9 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutDefenderForAISetting.json @@ -0,0 +1,56 @@ +{ + "operationId": "DefenderForAISettings_CreateOrUpdate", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "defenderForAISettingName": "Default", + "defenderForAISettings": { + "properties": { + "state": "Enabled" + } + }, + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "PutDefenderForAISetting", + "responses": { + "200": { + "body": { + "name": "Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdAt": "2022-04-03T04:41:33.937Z", + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "name": "Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdAt": "2022-04-03T04:41:33.937Z", + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutDeployment.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutDeployment.json new file mode 100644 index 000000000000..a1f5324bf259 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutDeployment.json @@ -0,0 +1,70 @@ +{ + "operationId": "Deployments_CreateOrUpdate", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "deployment": { + "properties": { + "deploymentState": "Running", + "model": { + "name": "ada", + "format": "OpenAI", + "version": "1" + }, + "serviceTier": "Priority" + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + }, + "deploymentName": "deploymentName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "PutDeployment", + "responses": { + "200": { + "body": { + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "properties": { + "deploymentState": "Running", + "model": { + "name": "ada", + "format": "OpenAI", + "version": "1" + }, + "provisioningState": "Succeeded", + "serviceTier": "Priority" + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + } + }, + "201": { + "body": { + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "properties": { + "deploymentState": "Running", + "model": { + "name": "ada", + "format": "OpenAI", + "version": "1" + }, + "provisioningState": "Accepted", + "serviceTier": "Priority" + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutEncryptionScope.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutEncryptionScope.json new file mode 100644 index 000000000000..c30aec04f355 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutEncryptionScope.json @@ -0,0 +1,79 @@ +{ + "operationId": "EncryptionScopes_CreateOrUpdate", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "encryptionScope": { + "properties": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "identityClientId": "00000000-0000-0000-0000-000000000000", + "keyName": "DevKeyWestUS2", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95" + }, + "state": "Enabled" + } + }, + "encryptionScopeName": "encryptionScopeName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "PutEncryptionScope", + "responses": { + "200": { + "body": { + "name": "encryptionScopeName", + "type": "Microsoft.CognitiveServices/accounts/encryptionScopes", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName", + "properties": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "identityClientId": "00000000-0000-0000-0000-000000000000", + "keyName": "DevKeyWestUS2", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95" + }, + "provisioningState": "Succeeded", + "state": "Enabled" + }, + "systemData": { + "createdAt": "2023-06-08T06:35:08.0662558Z", + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2023-06-08T06:35:08.0662558Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "name": "encryptionScopeName", + "type": "Microsoft.CognitiveServices/accounts/encryptionScopes", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName", + "properties": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "identityClientId": "00000000-0000-0000-0000-000000000000", + "keyName": "DevKeyWestUS2", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95" + }, + "provisioningState": "Succeeded", + "state": "Enabled" + }, + "systemData": { + "createdAt": "2023-06-08T06:35:08.0662558Z", + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2023-06-08T06:35:08.0662558Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutPrivateEndpointConnection.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutPrivateEndpointConnection.json new file mode 100644 index 000000000000..adc80476beec --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutPrivateEndpointConnection.json @@ -0,0 +1,56 @@ +{ + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "parameters": { + "accountName": "sto9699", + "api-version": "2026-05-01", + "monitor": "true", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "description": "Auto-Approved", + "status": "Approved" + } + } + }, + "resourceGroupName": "res7687", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "PutPrivateEndpointConnection", + "responses": { + "200": { + "body": { + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "description": "Auto-Approved", + "actionsRequired": "None", + "status": "Approved" + } + } + } + }, + "202": { + "body": { + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "description": "Auto-Approved", + "actionsRequired": "None", + "status": "Approved" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiBlocklist.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiBlocklist.json new file mode 100644 index 000000000000..f20a8d62561d --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiBlocklist.json @@ -0,0 +1,36 @@ +{ + "operationId": "RaiBlocklists_CreateOrUpdate", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiBlocklist": { + "properties": { + "description": "Basic blocklist description" + } + }, + "raiBlocklistName": "raiBlocklistName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "PutRaiBlocklist", + "responses": { + "200": { + "body": { + "name": "raiBlocklistName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName", + "properties": { + "description": "Basic blocklist description" + } + } + }, + "201": { + "body": { + "name": "raiBlocklistName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName", + "properties": { + "description": "Basic blocklist description" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiBlocklistItem.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiBlocklistItem.json new file mode 100644 index 000000000000..4c0979542c79 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiBlocklistItem.json @@ -0,0 +1,40 @@ +{ + "operationId": "RaiBlocklistItems_CreateOrUpdate", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiBlocklistItem": { + "properties": { + "isRegex": false, + "pattern": "Pattern To Block" + } + }, + "raiBlocklistItemName": "raiBlocklistItemName", + "raiBlocklistName": "raiBlocklistName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "PutRaiBlocklistItem", + "responses": { + "200": { + "body": { + "name": "raiBlocklistItemName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName", + "properties": { + "isRegex": false, + "pattern": "Pattern To Block" + } + } + }, + "201": { + "body": { + "name": "raiBlocklistItemName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName", + "properties": { + "isRegex": false, + "pattern": "Pattern To Block" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiExternalSafetyProvider.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiExternalSafetyProvider.json new file mode 100644 index 000000000000..786b164f6814 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiExternalSafetyProvider.json @@ -0,0 +1,53 @@ +{ + "operationId": "RaiExternalSafetyProvider_CreateOrUpdate", + "parameters": { + "api-version": "2026-05-01", + "safetyProvider": { + "properties": { + "keyVaultUri": "https://example.vault.azure.net", + "managedIdentity": "00000000-0000-0000-0000-000000000000", + "mode": "sync", + "providerId": "00000000-0000-0000-0000-000000000000", + "providerName": "safetyProviderName", + "secretName": "mySecretName", + "url": "https://example.webhook.endpoint" + } + }, + "safetyProviderName": "safetyProviderName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "PutRaiExternalSafetyProvider", + "responses": { + "200": { + "body": { + "name": "safetyProviderName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/raiExternalSafetyProviders/safetyProviderName", + "properties": { + "createdAt": "2025-07-01T00:00:00Z", + "keyVaultUri": "https://example.vault.azure.net", + "lastModifiedAt": "2025-07-02T00:00:00Z", + "managedIdentity": "00000000-0000-0000-0000-000000000000", + "mode": "sync", + "providerId": "00000000-0000-0000-0000-000000000000", + "providerName": "safetyProviderName", + "secretName": "mySecretName", + "url": "https://example.webhook.endpoint" + } + } + }, + "201": { + "body": { + "name": "safetyProviderName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/raiExternalSafetyProviders/safetyProviderName", + "properties": { + "createdAt": "2025-07-01T00:00:00Z", + "lastModifiedAt": "2025-07-02T00:00:00Z", + "mode": "sync", + "providerId": "00000000-0000-0000-0000-000000000000", + "providerName": "safetyProviderName", + "url": "https://example.webhook.endpoint" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiPolicy.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiPolicy.json new file mode 100644 index 000000000000..004bb8a5f41c --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiPolicy.json @@ -0,0 +1,285 @@ +{ + "operationId": "RaiPolicies_CreateOrUpdate", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiPolicy": { + "properties": { + "basePolicyName": "Microsoft.Default", + "contentFilters": [ + { + "name": "Hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Jailbreak", + "blocking": true, + "enabled": true, + "source": "Prompt" + }, + { + "name": "Protected Material Text", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Protected Material Code", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Profanity", + "blocking": true, + "enabled": true, + "source": "Prompt" + } + ], + "mode": "Asynchronous_filter" + } + }, + "raiPolicyName": "raiPolicyName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "PutRaiPolicy", + "responses": { + "200": { + "body": { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "contentFilters": [ + { + "name": "Hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Jailbreak", + "blocking": true, + "enabled": true, + "source": "Prompt" + }, + { + "name": "Protected Material Text", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Protected Material Code", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Profanity", + "blocking": true, + "enabled": true, + "source": "Prompt" + } + ], + "mode": "Asynchronous_filter" + } + } + }, + "201": { + "body": { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "contentFilters": [ + { + "name": "Hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Jailbreak", + "blocking": true, + "enabled": true, + "source": "Prompt" + }, + { + "name": "Protected Material Text", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Protected Material Code", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Profanity", + "blocking": true, + "enabled": true, + "source": "Prompt" + } + ], + "mode": "Asynchronous_filter" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiToolLabel.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiToolLabel.json new file mode 100644 index 000000000000..a027e59044e0 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiToolLabel.json @@ -0,0 +1,95 @@ +{ + "operationId": "RaiToolLabels_CreateOrUpdate", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiToolConnectionName": "Web_Search", + "raiToolLabel": { + "properties": { + "accountScope": { + "labelValues": { + "confidentiality": "low" + } + }, + "projectScopes": [ + { + "labelValues": { + "confidentiality": "low" + }, + "project": "test-project" + }, + { + "labelValues": { + "confidentiality": "low" + }, + "project": "sample-project" + } + ], + "toolConnectionName": "Web_Search" + } + }, + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "PutRaiToolLabel", + "responses": { + "200": { + "body": { + "name": "Web_Search", + "type": "Microsoft.CognitiveServices/accounts/raiToolLabels", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiToolLabels/Web_Search", + "properties": { + "accountScope": { + "labelValues": { + "confidentiality": "low" + } + }, + "projectScopes": [ + { + "labelValues": { + "confidentiality": "low" + }, + "project": "test-project" + }, + { + "labelValues": { + "confidentiality": "low" + }, + "project": "sample-project" + } + ], + "toolConnectionName": "Web_Search" + } + } + }, + "201": { + "body": { + "name": "Web_Search", + "type": "Microsoft.CognitiveServices/accounts/raiToolLabels", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiToolLabels/Web_Search", + "properties": { + "accountScope": { + "labelValues": { + "confidentiality": "low" + } + }, + "projectScopes": [ + { + "labelValues": { + "confidentiality": "low" + }, + "project": "test-project" + }, + { + "labelValues": { + "confidentiality": "low" + }, + "project": "sample-project" + } + ], + "toolConnectionName": "Web_Search" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiTopic.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiTopic.json new file mode 100644 index 000000000000..76d186b2f97a --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutRaiTopic.json @@ -0,0 +1,50 @@ +{ + "operationId": "RaiTopics_CreateOrUpdate", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiTopic": { + "properties": { + "description": "This is a sample topic.", + "sampleBlobUrl": "https://example.blob.core.windows.net/sampleblob", + "topicName": "raiTopicName" + } + }, + "raiTopicName": "raiTopicName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "PutRaiTopic", + "responses": { + "200": { + "body": { + "name": "raiTopicName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiTopics/raiTopicName", + "properties": { + "description": "This is a sample topic.", + "createdAt": "2025-07-01T00:00:00Z", + "lastModifiedAt": "2025-07-02T00:00:00Z", + "sampleBlobUrl": "https://example.blob.core.windows.net/sampleblob", + "status": "Training", + "topicId": "00000000-0000-0000-0000-000000000000", + "topicName": "raiTopicName" + } + } + }, + "201": { + "body": { + "name": "raiTopicName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiTopics/raiTopicName", + "properties": { + "description": "This is a sample topic.", + "createdAt": "2025-07-01T00:00:00Z", + "lastModifiedAt": "2025-07-02T00:00:00Z", + "sampleBlobUrl": "https://example.blob.core.windows.net/sampleblob", + "status": "Training", + "topicId": "00000000-0000-0000-0000-000000000000", + "topicName": "raiTopicName" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutSubscriptionRaiPolicy.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutSubscriptionRaiPolicy.json new file mode 100644 index 000000000000..49bed5283fc1 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/PutSubscriptionRaiPolicy.json @@ -0,0 +1,285 @@ +{ + "operationId": "SubscriptionRaiPolicy_CreateOrUpdate", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiPolicy": { + "properties": { + "basePolicyName": "Microsoft.Default", + "contentFilters": [ + { + "name": "Hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Jailbreak", + "blocking": true, + "enabled": true, + "source": "Prompt" + }, + { + "name": "Protected Material Text", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Protected Material Code", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Profanity", + "blocking": true, + "enabled": true, + "source": "Prompt" + } + ], + "mode": "Asynchronous_filter" + } + }, + "raiPolicyName": "raiPolicyName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "PutRaiPolicy", + "responses": { + "200": { + "body": { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "contentFilters": [ + { + "name": "Hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Jailbreak", + "blocking": true, + "enabled": true, + "source": "Prompt" + }, + { + "name": "Protected Material Text", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Protected Material Code", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Profanity", + "blocking": true, + "enabled": true, + "source": "Prompt" + } + ], + "mode": "Asynchronous_filter" + } + } + }, + "201": { + "body": { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "contentFilters": [ + { + "name": "Hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Jailbreak", + "blocking": true, + "enabled": true, + "source": "Prompt" + }, + { + "name": "Protected Material Text", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Protected Material Code", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Profanity", + "blocking": true, + "enabled": true, + "source": "Prompt" + } + ], + "mode": "Asynchronous_filter" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ReconcileNetworkSecurityPerimeterConfigurations.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ReconcileNetworkSecurityPerimeterConfigurations.json new file mode 100644 index 000000000000..7d48fd832267 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ReconcileNetworkSecurityPerimeterConfigurations.json @@ -0,0 +1,53 @@ +{ + "operationId": "NetworkSecurityPerimeterConfigurations_Reconcile", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "nspConfigurationName": "NSPConfigurationName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ReconcileNetworkSecurityPerimeterConfigurations", + "responses": { + "200": { + "body": { + "name": "networkSecurityPerimeterConfigurationName", + "type": "Microsoft.CognitiveServices/accounts/networkSecurityPerimeterConfigurations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/networkSecurityPerimeterConfigurations/config1", + "properties": { + "networkSecurityPerimeter": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.Network/networkSecurityPerimeters/perimeter", + "location": "East US", + "perimeterGuid": "00000000-0000-0000-0000-000000000000" + }, + "profile": { + "name": "profileName", + "accessRules": [ + { + "name": "ruleName", + "properties": { + "addressPrefixes": [ + "148.0.0.0/8", + "152.4.6.0/24" + ], + "direction": "Inbound" + } + } + ], + "accessRulesVersion": 1 + }, + "provisioningState": "Succeeded", + "resourceAssociation": { + "name": "associationName", + "accessMode": "Enforced" + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/RegenerateKey.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/RegenerateKey.json new file mode 100644 index 000000000000..f43fd7148f7e --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/RegenerateKey.json @@ -0,0 +1,21 @@ +{ + "operationId": "Accounts_RegenerateKey", + "parameters": { + "accountName": "myAccount", + "api-version": "2026-05-01", + "parameters": { + "keyName": "Key2" + }, + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Regenerate Keys", + "responses": { + "200": { + "body": { + "key1": "KEY1", + "key2": "KEY2" + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ResumeDeployment.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ResumeDeployment.json new file mode 100644 index 000000000000..127e7ba69ca8 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/ResumeDeployment.json @@ -0,0 +1,33 @@ +{ + "operationId": "Deployments_Resume", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "deploymentName": "deploymentName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "ResumeDeployment", + "responses": { + "200": { + "body": { + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "properties": { + "deploymentState": "Running", + "model": { + "name": "gpt-4", + "format": "OpenAI", + "version": "0613" + }, + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/TestRaiExternalSafetyProvider.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/TestRaiExternalSafetyProvider.json new file mode 100644 index 000000000000..e426d2b4af60 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/TestRaiExternalSafetyProvider.json @@ -0,0 +1,62 @@ +{ + "operationId": "TestRaiExternalSafetyProvider_CreateOrUpdate", + "parameters": { + "accountName": "myCognitiveAccount", + "api-version": "2026-05-01", + "resourceGroupName": "myResourceGroup", + "safetyProvider": { + "properties": { + "keyVaultUri": "https://contoso-vault.vault.azure.net/", + "managedIdentity": "f3b9c2e7-4aad-4b1f-9d9c-9e9b1e9b1f9b", + "mode": "sync", + "providerId": "00000000-0000-0000-0000-000000000000", + "providerName": "safetyProviderName", + "secretName": "safety-provider-secret", + "url": "https://example-safety-provider.contoso.com/webhook" + } + }, + "safetyProviderName": "mySafetyProvider", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "TestRaiExternalSafetyProvider", + "responses": { + "200": { + "body": { + "name": "mySafetyProvider", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/raiExternalSafetyProviders/mySafetyProvider", + "properties": { + "keyVaultUri": "https://contoso-vault.vault.azure.net/", + "managedIdentity": "f3b9c2e7-4aad-4b1f-9d9c-9e9b1e9b1f9b", + "mode": "sync", + "providerId": "00000000-0000-0000-0000-000000000000", + "providerName": "safetyProviderName", + "secretName": "safety-provider-secret", + "url": "https://example-safety-provider.contoso.com/webhook" + } + } + }, + "201": { + "body": { + "name": "mySafetyProvider", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/raiExternalSafetyProviders/mySafetyProvider", + "properties": { + "keyVaultUri": "https://contoso-vault.vault.azure.net/", + "managedIdentity": "f3b9c2e7-4aad-4b1f-9d9c-9e9b1e9b1f9b", + "mode": "sync", + "providerId": "00000000-0000-0000-0000-000000000000", + "providerName": "safetyProviderName", + "secretName": "safety-provider-secret", + "url": "https://example-safety-provider.contoso.com/webhook" + } + } + }, + "default": { + "body": { + "error": { + "code": "BadRequest", + "message": "The request is invalid." + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateAccount.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateAccount.json new file mode 100644 index 000000000000..dd268e68400c --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateAccount.json @@ -0,0 +1,60 @@ +{ + "operationId": "Accounts_Update", + "parameters": { + "account": { + "location": "global", + "sku": { + "name": "S2" + } + }, + "accountName": "bingSearch", + "api-version": "2026-05-01", + "resourceGroupName": "bvttest", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Update Account", + "responses": { + "200": { + "body": { + "name": "bingSearch", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch", + "kind": "Bing.Search", + "location": "global", + "properties": { + "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S2" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-06-01", + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "202": { + "body": { + "name": "bingSearch", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch", + "kind": "Bing.Search", + "location": "global", + "properties": { + "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S2" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-06-01", + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateDefenderForAISetting.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateDefenderForAISetting.json new file mode 100644 index 000000000000..693196b42dbe --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateDefenderForAISetting.json @@ -0,0 +1,37 @@ +{ + "operationId": "DefenderForAISettings_Update", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "defenderForAISettingName": "Default", + "defenderForAISettings": { + "properties": { + "state": "Enabled" + } + }, + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "UpdateDefenderForAISetting", + "responses": { + "200": { + "body": { + "name": "Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdAt": "2022-04-03T04:41:33.937Z", + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateDeployment.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateDeployment.json new file mode 100644 index 000000000000..c6ef4de62505 --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateDeployment.json @@ -0,0 +1,45 @@ +{ + "operationId": "Deployments_Update", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "deployment": { + "sku": { + "name": "Standard", + "capacity": 1 + } + }, + "deploymentName": "deploymentName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "UpdateDeployment", + "responses": { + "200": { + "body": { + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "properties": { + "deploymentState": "Paused", + "model": { + "name": "ada", + "format": "OpenAI", + "version": "1" + }, + "provisioningState": "Succeeded", + "serviceTier": "Priority" + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateProjects.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateProjects.json new file mode 100644 index 000000000000..18f586946dbc --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateProjects.json @@ -0,0 +1,65 @@ +{ + "operationId": "Projects_Update", + "parameters": { + "accountName": "bingSearch", + "api-version": "2026-05-01", + "project": { + "location": "global", + "properties": { + "description": "new description." + } + }, + "projectName": "projectName", + "resourceGroupName": "bvttest", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Update Project", + "responses": { + "200": { + "body": { + "name": "projectName", + "type": "Microsoft.CognitiveServices/accounts/projects", + "etag": "W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch/projects/projectName", + "location": "global", + "properties": { + "description": "new description.", + "displayName": "myProject", + "endpoints": { + "OpenAI Dall-E API": "https://customSubDomainName.openai.azure.com/", + "OpenAI Language Model Instance API": "https://customSubDomainName.openai.azure.com/" + }, + "isDefault": false, + "provisioningState": "Succeeded" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-06-01", + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "202": { + "body": { + "name": "projectName", + "type": "Microsoft.CognitiveServices/accounts/projects", + "etag": "W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch/projects/projectName", + "location": "global", + "properties": { + "description": "new description.", + "displayName": "myProject", + "endpoints": { + "OpenAI Dall-E API": "https://customSubDomainName.openai.azure.com/", + "OpenAI Language Model Instance API": "https://customSubDomainName.openai.azure.com/" + }, + "isDefault": false, + "provisioningState": "Succeeded" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-06-01", + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateQuotaTier.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateQuotaTier.json new file mode 100644 index 000000000000..f74de5a31a4d --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateQuotaTier.json @@ -0,0 +1,28 @@ +{ + "operationId": "QuotaTiers_Update", + "parameters": { + "default": "default", + "api-version": "2026-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tier": { + "properties": { + "tierUpgradePolicy": "NoAutoUpgrade" + } + } + }, + "title": "Update the quota tier resource for a subscription", + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.CognitiveServices/quotaTiers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/quotaTiers/default", + "properties": { + "assignmentDate": "2025-06-09T18:13:29.389Z", + "currentTierName": "Free-Tier", + "tierUpgradePolicy": "NoAutoUpgrade" + } + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateSharedCommitmentPlan.json b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateSharedCommitmentPlan.json new file mode 100644 index 000000000000..3770717504cd --- /dev/null +++ b/specification/cognitiveservices/CognitiveServices.Management/examples/2026-05-01/UpdateSharedCommitmentPlan.json @@ -0,0 +1,46 @@ +{ + "operationId": "CommitmentPlans_UpdatePlan", + "parameters": { + "api-version": "2026-05-01", + "commitmentPlan": { + "tags": { + "name": "value" + } + }, + "commitmentPlanName": "commitmentPlanName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Create Commitment Plan", + "responses": { + "200": { + "body": { + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "kind": "SpeechServices", + "location": "West US", + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "STT", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + }, + "tags": { + "name": "value" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/cognitiveservices/CognitiveServices.Management/main.tsp b/specification/cognitiveservices/CognitiveServices.Management/main.tsp index d5786b0ae916..7b4fac111182 100644 --- a/specification/cognitiveservices/CognitiveServices.Management/main.tsp +++ b/specification/cognitiveservices/CognitiveServices.Management/main.tsp @@ -88,6 +88,11 @@ enum Versions { * The 2026-03-15-preview API version. */ v2026_03_15_preview: "2026-03-15-preview", + + /** + * The 2026-05-01 API version. + */ + v2026_05_01: "2026-05-01", } interface Operations extends Azure.ResourceManager.Operations {} diff --git a/specification/cognitiveservices/CognitiveServices.Management/models.tsp b/specification/cognitiveservices/CognitiveServices.Management/models.tsp index 44c8a1009c24..8440018fbbce 100644 --- a/specification/cognitiveservices/CognitiveServices.Management/models.tsp +++ b/specification/cognitiveservices/CognitiveServices.Management/models.tsp @@ -199,6 +199,7 @@ union QuotaUsageStatus { @added(Versions.v2026_01_15_preview) @removed(Versions.v2026_03_01) @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) union QuotaScopeType { string, #suppress "@azure-tools/typespec-azure-core/documentation-required" "Regional quota scope" @@ -1645,6 +1646,7 @@ model AccountProperties { @added(Versions.v2026_01_15_preview) @removed(Versions.v2026_03_01) @added(Versions.v2026_03_15_preview) + @removed(Versions.v2026_05_01) foundryAutoUpgrade?: FoundryAutoUpgrade; /** @@ -1669,6 +1671,7 @@ model AccountProperties { @added(Versions.v2026_01_15_preview) @removed(Versions.v2026_03_01) @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) union FoundryAutoUpgradeMode { string, @@ -1690,6 +1693,7 @@ union FoundryAutoUpgradeMode { @added(Versions.v2026_01_15_preview) @removed(Versions.v2026_03_01) @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model FoundryAutoUpgrade { /** * Gets or sets the auto-upgrade mode. @@ -2322,6 +2326,7 @@ model Usage { @added(Versions.v2026_01_15_preview) @removed(Versions.v2026_03_01) @added(Versions.v2026_03_15_preview) + @removed(Versions.v2026_05_01) scopeType?: QuotaScopeType | null; /** @@ -2331,6 +2336,7 @@ model Usage { @added(Versions.v2026_01_15_preview) @removed(Versions.v2026_03_01) @added(Versions.v2026_03_15_preview) + @removed(Versions.v2026_05_01) scopeId?: string | null; } @@ -2853,6 +2859,7 @@ model ModelSkuCapacityProperties { @added(Versions.v2026_01_15_preview) @removed(Versions.v2026_03_01) @added(Versions.v2026_03_15_preview) + @removed(Versions.v2026_05_01) scopeId?: string | null; /** @@ -2862,6 +2869,7 @@ model ModelSkuCapacityProperties { @added(Versions.v2026_01_15_preview) @removed(Versions.v2026_03_01) @added(Versions.v2026_03_15_preview) + @removed(Versions.v2026_05_01) scopeType?: QuotaScopeType | null; } @@ -3250,6 +3258,7 @@ model SkuResource { * The object being used to update sku of a resource, in general used for PATCH operations. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model PatchResourceSku { /** * The resource model definition representing SKU @@ -5662,6 +5671,7 @@ model RaiBlocklistItemsBulkDeleteRequest is Array; * Properties of a Cognitive Services managed compute deployment. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model ManagedComputeDeploymentProperties { /** * AzureML Registry model asset URI. Required on creation; immutable after creation. @@ -5737,6 +5747,7 @@ model ManagedComputeDeploymentProperties { * Provisioning status details for a managed compute deployment. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model ManagedComputeDeploymentProvisioningDetails { /** * A human-readable status message from the last provisioning operation. @@ -5754,6 +5765,7 @@ model ManagedComputeDeploymentProvisioningDetails { * Populated when provisioningState is Succeeded. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model ManagedComputeDeploymentRoutes { /** * Relative path to the chat completions scoring endpoint. @@ -5775,6 +5787,7 @@ model ManagedComputeDeploymentRoutes { * The list of managed compute deployments. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model ManagedComputeDeploymentListResult { /** * The link used to get the next page of managed compute deployments. @@ -5794,6 +5807,7 @@ model ManagedComputeDeploymentListResult { * The provisioning state of a compute resource. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) union ComputeProvisioningState { string, @@ -5835,6 +5849,7 @@ union ComputeProvisioningState { * VM priority for a compute pool. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) union VmPriority { string, @@ -5849,6 +5864,7 @@ union VmPriority { * A compute pool configuration. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model Pool { /** * The name of the pool. @@ -5875,6 +5891,7 @@ model Pool { * The type of compute resource. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) union ComputeType { string, @@ -5890,6 +5907,7 @@ union ComputeType { * The computeType discriminator determines the concrete property shape. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) @discriminator("computeType") model ComputeProperties { /** @@ -5920,6 +5938,7 @@ model ComputeProperties { * Properties for a Cluster (AKS-backed) compute resource. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model ClusterComputeProperties extends ComputeProperties { /** * The type of compute resource. @@ -5941,6 +5960,7 @@ model ClusterComputeProperties extends ComputeProperties { * Properties for a Container Instance compute resource. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model ContainerInstanceComputeProperties extends ComputeProperties { /** * The type of compute resource. @@ -5978,6 +5998,7 @@ model ContainerInstanceComputeProperties extends ComputeProperties { * SSH configuration for a Container Instance compute. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model SshSettings { /** * The SSH public key for authenticating to the compute instance. @@ -5994,6 +6015,7 @@ model SshSettings { * Network connectivity endpoints for a Container Instance compute. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model ConnectivityEndpoints { /** * The public IP address of the compute instance. @@ -6012,6 +6034,7 @@ model ConnectivityEndpoints { * The list of cognitive services computes operation response. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model ComputeListResult { /** * The link used to get the next page of compute list. @@ -6030,6 +6053,7 @@ model ComputeListResult { * Properties for a Workbench resource. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model WorkbenchProperties { /** * ARM resource ID of the parent cluster that hosts this workbench. @@ -6091,6 +6115,7 @@ model WorkbenchProperties { * The list of workbenches operation response. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model WorkbenchListResult { /** * The link used to get the next page of workbench list. @@ -6109,6 +6134,7 @@ model WorkbenchListResult { * Deployment detail within a managed compute usage entry. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model ManagedComputeDeploymentInfo { /** * Full ARM resource ID of the deployment. @@ -6140,6 +6166,7 @@ model ManagedComputeDeploymentInfo { * Managed compute quota usage for a specific SKU. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model ManagedComputeUsage { /** * Fully qualified resource ID for the managed compute usage. @@ -6190,6 +6217,7 @@ model ManagedComputeUsage { * List of managed compute quota entries. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model ManagedComputeUsageListResult { /** * The link used to get the next page of managed compute usages. @@ -6209,6 +6237,7 @@ model ManagedComputeUsageListResult { * Request body for the evaluateDeploymentPolicies action. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model EvaluateDeploymentPoliciesRequest { /** * The list of hypothetical deployments to evaluate against Azure Policy. @@ -6220,6 +6249,7 @@ model EvaluateDeploymentPoliciesRequest { * A hypothetical deployment definition used for policy dry-run evaluation. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model EvaluateDeploymentPoliciesDeployment { /** * The name of the hypothetical deployment. @@ -6236,6 +6266,7 @@ model EvaluateDeploymentPoliciesDeployment { * Properties of a hypothetical deployment for policy evaluation. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model EvaluateDeploymentPoliciesDeploymentProperties { /** * The model to evaluate. @@ -6252,6 +6283,7 @@ model EvaluateDeploymentPoliciesDeploymentProperties { * Response body for the evaluateDeploymentPolicies action. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model EvaluateDeploymentPoliciesResponse { /** * Per-deployment policy evaluation results, keyed by deployment name. @@ -6264,6 +6296,7 @@ model EvaluateDeploymentPoliciesResponse { * The outcome of a policy evaluation. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) union PolicyEvaluationOutcome { string, @@ -6281,6 +6314,7 @@ union PolicyEvaluationOutcome { * Policy evaluation result for a single deployment. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model DeploymentPolicyEvaluationResult { /** * The evaluation outcome. @@ -6303,6 +6337,7 @@ model DeploymentPolicyEvaluationResult { * Details of a non-compliant policy assignment. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model PolicyAssignmentEvaluationDetails { /** * The policy assignment ID. @@ -6345,6 +6380,7 @@ model PolicyAssignmentEvaluationDetails { * Details of a policy expression evaluation. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model PolicyExpressionEvaluationDetails { /** * The policy expression. @@ -6382,6 +6418,7 @@ model PolicyExpressionEvaluationDetails { */ #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "ManagedComputeCapacity is a read-only resource that does not have a provisioning state" @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model ManagedComputeCapacityProperties { /** * The type of accelerator (e.g., Azure.A100, Azure.H100). @@ -6413,6 +6450,7 @@ model ManagedComputeCapacityProperties { * Capacity information for a specific deployment size. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model DeploymentSizeCapacity { /** * The number of accelerators required per model instance. @@ -6437,6 +6475,7 @@ model DeploymentSizeCapacity { * The list of managed compute capacities response. */ @added(Versions.v2026_03_15_preview) +@removed(Versions.v2026_05_01) model ManagedComputeCapacityListResult { /** * The link used to get the next page of managed compute capacities. diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/cognitiveservices.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/cognitiveservices.json new file mode 100644 index 000000000000..2268a2bb2808 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/cognitiveservices.json @@ -0,0 +1,17125 @@ +{ + "swagger": "2.0", + "info": { + "title": "CognitiveServicesManagementClient", + "version": "2026-05-01", + "description": "Cognitive Services Management Client", + "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": "CognitiveServicesAccounts" + }, + { + "name": "Operations" + }, + { + "name": "PrivateLinkResources" + }, + { + "name": "TestRaiExternalSafetyProvider" + }, + { + "name": "PrivateEndpointConnections" + }, + { + "name": "Deployments" + }, + { + "name": "CommitmentPlans" + }, + { + "name": "CognitiveServicesCommitmentPlans" + }, + { + "name": "EncryptionScopes" + }, + { + "name": "RaiPolicies" + }, + { + "name": "SubscriptionRaiPolicy" + }, + { + "name": "RaiBlocklists" + }, + { + "name": "RaiTopics" + }, + { + "name": "RaiExternalSafetyProvider" + }, + { + "name": "RaiToolLabels" + }, + { + "name": "RaiContentFilters" + }, + { + "name": "NetworkSecurityPerimeterConfigurations" + }, + { + "name": "DefenderForAISettings" + }, + { + "name": "CognitiveServicesProjects" + }, + { + "name": "AccountConnectionResource" + }, + { + "name": "ProjectConnectionResource" + }, + { + "name": "AccountCapabilityHost" + }, + { + "name": "ProjectCapabilityHost" + }, + { + "name": "QuotaTier" + }, + { + "name": "ManagedNetwork" + }, + { + "name": "AgentApplication" + }, + { + "name": "AgentDeployment" + }, + { + "name": "Skus" + }, + { + "name": "Usages" + }, + { + "name": "CommitmentTiers" + }, + { + "name": "Models" + }, + { + "name": "ModelCapacities" + } + ], + "paths": { + "/providers/Microsoft.CognitiveServices/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "Lists all the available Cognitive Services account operations.", + "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": { + "Get Operations": { + "$ref": "./examples/GetOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/accounts": { + "get": { + "operationId": "Accounts_List", + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Returns all the resources of a particular type belonging to a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AccountListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Accounts by Subscription": { + "$ref": "./examples/ListAccountsBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/calculateModelCapacity": { + "post": { + "operationId": "calculateModelCapacity", + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Model capacity calculator.", + "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", + "description": "The request body", + "required": true, + "schema": { + "$ref": "#/definitions/CalculateModelCapacityParameter" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CalculateModelCapacityResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Calculate Model Capacity": { + "$ref": "./examples/CalculateModelCapacity.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/checkDomainAvailability": { + "post": { + "operationId": "CheckDomainAvailability", + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Check whether a domain is available.", + "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", + "description": "The request body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckDomainAvailabilityParameter" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DomainAvailability" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Check SKU Availability": { + "$ref": "./examples/CheckDomainAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/commitmentPlans": { + "get": { + "operationId": "CommitmentPlans_ListPlansBySubscription", + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Returns all the resources of a particular type belonging to a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CommitmentPlanListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Accounts by Subscription": { + "$ref": "./examples/ListSharedCommitmentPlansBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/deletedAccounts": { + "get": { + "operationId": "DeletedAccounts_List", + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Returns all the resources of a particular type belonging to a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AccountListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Deleted Accounts by Subscription": { + "$ref": "./examples/ListDeletedAccountsBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/checkSkuAvailability": { + "post": { + "operationId": "CheckSkuAvailability", + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Check available SKUs.", + "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/LocationParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The request body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckSkuAvailabilityParameter" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SkuAvailabilityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Check SKU Availability": { + "$ref": "./examples/CheckSkuAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/commitmentTiers": { + "get": { + "operationId": "CommitmentTiers_List", + "tags": [ + "CommitmentTiers" + ], + "description": "List Commitment Tiers.", + "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/LocationParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CommitmentTierListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListCommitmentTiers": { + "$ref": "./examples/ListCommitmentTiers.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/modelCapacities": { + "get": { + "operationId": "LocationBasedModelCapacities_List", + "tags": [ + "ModelCapacities" + ], + "description": "List Location Based ModelCapacities.", + "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/LocationParameter" + }, + { + "name": "modelFormat", + "in": "query", + "description": "The format of the Model", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "modelName", + "in": "query", + "description": "The name of the Model", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "modelVersion", + "in": "query", + "description": "The version of the Model", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ModelCapacityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListLocationBasedModelCapacities": { + "$ref": "./examples/ListLocationBasedModelCapacities.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/models": { + "get": { + "operationId": "Models_List", + "tags": [ + "Models" + ], + "description": "List Models.", + "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/LocationParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ModelListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListLocationModels": { + "$ref": "./examples/ListLocationModels.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/raiContentFilters": { + "get": { + "operationId": "RaiContentFilters_List", + "tags": [ + "RaiContentFilters" + ], + "description": "List Content Filters types.", + "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/LocationParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RaiContentFilterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListRaiContentFilters": { + "$ref": "./examples/ListRaiContentFilters.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/raiContentFilters/{filterName}": { + "get": { + "operationId": "RaiContentFilters_Get", + "tags": [ + "RaiContentFilters" + ], + "description": "Get Content Filters by Name.", + "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/LocationParameter" + }, + { + "name": "filterName", + "in": "path", + "description": "The name of the RAI Content Filter.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RaiContentFilter" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetRaiContentFilters": { + "$ref": "./examples/GetRaiContentFilter.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/resourceGroups/{resourceGroupName}/deletedAccounts/{accountName}": { + "get": { + "operationId": "DeletedAccounts_Get", + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Returns a Cognitive Services account specified by the parameters.", + "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/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Account": { + "$ref": "./examples/GetDeletedAccount.json" + } + } + }, + "delete": { + "operationId": "DeletedAccounts_Purge", + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Deletes a Cognitive Services account from the resource group.", + "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/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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 does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Account": { + "$ref": "./examples/PurgeDeletedAccount.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/usages": { + "get": { + "operationId": "Usages_List", + "tags": [ + "Usages" + ], + "description": "Get usages for the requested subscription", + "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/LocationParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Usages": { + "$ref": "./examples/ListUsages.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/modelCapacities": { + "get": { + "operationId": "ModelCapacities_List", + "tags": [ + "ModelCapacities" + ], + "description": "List ModelCapacities.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "modelFormat", + "in": "query", + "description": "The format of the Model", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "modelName", + "in": "query", + "description": "The name of the Model", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "modelVersion", + "in": "query", + "description": "The version of the Model", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ModelCapacityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListModelCapacities": { + "$ref": "./examples/ListModelCapacities.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/quotaTiers": { + "get": { + "operationId": "QuotaTiers_ListBySubscription", + "tags": [ + "QuotaTier" + ], + "description": "Returns all the resources of a particular type belonging to a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/QuotaTierListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List the Quota Tier for a subscription": { + "$ref": "./examples/ListQuotaTiers.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/quotaTiers/{default}": { + "get": { + "operationId": "QuotaTiers_Get", + "tags": [ + "QuotaTier" + ], + "summary": "Gets the Quota Tier for a subscription", + "description": "Gets the Quota Tier information for the given subscription. QuotaTiers is a subscription wide resource type. It holds current tier information.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "default", + "in": "path", + "description": "Default parameter. Leave the value as default.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/QuotaTier" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get the Quota Tier information for a subscription": { + "$ref": "./examples/GetQuotaTier.json" + } + } + }, + "put": { + "operationId": "QuotaTiers_CreateOrUpdate", + "tags": [ + "QuotaTier" + ], + "summary": "Updates the Quota Tier resource for a subscription.", + "description": "Update the Quota Tier information for the given subscription. QuotaTiers is a subscription wide resource type. It holds current tier information.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "default", + "in": "path", + "description": "Default parameter. Leave the value as default.", + "required": true, + "type": "string" + }, + { + "name": "tier", + "in": "body", + "description": "The parameters to provide for the quota tier resource.", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaTier" + } + } + ], + "responses": { + "200": { + "description": "Resource 'QuotaTier' update operation succeeded", + "schema": { + "$ref": "#/definitions/QuotaTier" + } + }, + "201": { + "description": "Resource 'QuotaTier' create operation succeeded", + "schema": { + "$ref": "#/definitions/QuotaTier" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update the quota tier resource for a subscription": { + "$ref": "./examples/CreateOrUpdateQuotaTier.json" + } + } + }, + "patch": { + "operationId": "QuotaTiers_Update", + "tags": [ + "QuotaTier" + ], + "summary": "Updates the Quota Tier resource for a subscription. The only properties that can be updated are \"tierUpgradePolicy\"", + "description": "Update the Quota Tier information for the given subscription. QuotaTiers is a subscription wide resource type. It holds current tier information.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "default", + "in": "path", + "description": "Default parameter. Leave the value as default.", + "required": true, + "type": "string" + }, + { + "name": "tier", + "in": "body", + "description": "The parameters to provide for the quota tier resource.", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaTier" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/QuotaTier" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update the quota tier resource for a subscription": { + "$ref": "./examples/UpdateQuotaTier.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/raiExternalSafetyProviders": { + "get": { + "operationId": "RaiExternalSafetyProviders_List", + "tags": [ + "RaiExternalSafetyProvider" + ], + "description": "Gets the safety providers associated with the subscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RaiExternalSafetyProviderResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListRaiExternalSafetyProviders": { + "$ref": "./examples/ListRaiExternalSafetyProviders.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/raiExternalSafetyProviders/{safetyProviderName}": { + "get": { + "operationId": "RaiExternalSafetyProvider_Get", + "tags": [ + "RaiExternalSafetyProvider" + ], + "description": "Gets the specified external safety provider associated with the Subscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "safetyProviderName", + "in": "path", + "description": "The name of the Rai External Safety Provider associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RaiExternalSafetyProviderSchema" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetRaiExternalSafetyProvider": { + "$ref": "./examples/GetRaiExternalSafetyProvider.json" + } + } + }, + "put": { + "operationId": "RaiExternalSafetyProvider_CreateOrUpdate", + "tags": [ + "RaiExternalSafetyProvider" + ], + "description": "Create the rai safety provider associated with the subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "safetyProviderName", + "in": "path", + "description": "The name of the Rai External Safety Provider associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "safetyProvider", + "in": "body", + "description": "Properties describing the rai external safety provider.", + "required": true, + "schema": { + "$ref": "#/definitions/RaiExternalSafetyProviderSchema" + } + } + ], + "responses": { + "200": { + "description": "Resource 'RaiExternalSafetyProviderSchema' update operation succeeded", + "schema": { + "$ref": "#/definitions/RaiExternalSafetyProviderSchema" + } + }, + "201": { + "description": "Resource 'RaiExternalSafetyProviderSchema' create operation succeeded", + "schema": { + "$ref": "#/definitions/RaiExternalSafetyProviderSchema" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PutRaiExternalSafetyProvider": { + "$ref": "./examples/PutRaiExternalSafetyProvider.json" + } + } + }, + "delete": { + "operationId": "RaiExternalSafetyProvider_Delete", + "tags": [ + "RaiExternalSafetyProvider" + ], + "description": "Deletes the specified custom topic associated with the subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "safetyProviderName", + "in": "path", + "description": "The name of the Rai External Safety Provider associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "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 does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteRaiTopic": { + "$ref": "./examples/DeleteRaiExternalSafetyProvider.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/raiPolicy/{raiPolicyName}": { + "get": { + "operationId": "SubscriptionRaiPolicy_Get", + "tags": [ + "SubscriptionRaiPolicy" + ], + "description": "Gets the specified Content Filters associated with the Subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "raiPolicyName", + "in": "path", + "description": "The name of the RaiPolicy associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RaiPolicy" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetRaiPolicy": { + "$ref": "./examples/GetSubscriptionRaiPolicy.json" + } + } + }, + "put": { + "operationId": "SubscriptionRaiPolicy_CreateOrUpdate", + "tags": [ + "SubscriptionRaiPolicy" + ], + "description": "Update the state of specified Content Filters associated with the subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "raiPolicyName", + "in": "path", + "description": "The name of the RaiPolicy associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiPolicy", + "in": "body", + "description": "Properties describing the Content Filters.", + "required": true, + "schema": { + "$ref": "#/definitions/RaiPolicy" + } + } + ], + "responses": { + "200": { + "description": "Resource 'RaiPolicy' update operation succeeded", + "schema": { + "$ref": "#/definitions/RaiPolicy" + } + }, + "201": { + "description": "Resource 'RaiPolicy' create operation succeeded", + "schema": { + "$ref": "#/definitions/RaiPolicy" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PutRaiPolicy": { + "$ref": "./examples/PutSubscriptionRaiPolicy.json" + } + } + }, + "delete": { + "operationId": "SubscriptionRaiPolicy_Delete", + "tags": [ + "SubscriptionRaiPolicy" + ], + "description": "Deletes the specified Content Filters associated with the subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "raiPolicyName", + "in": "path", + "description": "The name of the RaiPolicy associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "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 does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteRaiPolicy": { + "$ref": "./examples/DeleteSubscriptionRaiPolicy.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/skus": { + "get": { + "operationId": "ResourceSkus_List", + "tags": [ + "Skus", + "CognitiveServicesAccounts" + ], + "description": "Gets the list of Microsoft.CognitiveServices SKUs available for your Subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ResourceSkuListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Regenerate Keys": { + "$ref": "./examples/GetSkus.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts": { + "get": { + "operationId": "Accounts_ListByResourceGroup", + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Returns all the resources of a particular type belonging to a resource group", + "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" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AccountListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Accounts by Resource Group": { + "$ref": "./examples/ListAccountsByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}": { + "get": { + "operationId": "Accounts_Get", + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Returns a Cognitive Services account specified by the parameters.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Account": { + "$ref": "./examples/GetAccount.json" + } + } + }, + "put": { + "operationId": "Accounts_Create", + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Create Cognitive Services Account. Accounts is a resource group wide resource type. It holds the keys for developer to access intelligent APIs. It's also the resource type for billing.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "account", + "in": "body", + "description": "The parameters to provide for the created account.", + "required": true, + "schema": { + "$ref": "#/definitions/Account" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Account' update operation succeeded", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "201": { + "description": "Resource 'Account' create operation succeeded", + "schema": { + "$ref": "#/definitions/Account" + }, + "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." + } + } + }, + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/Account" + }, + "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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create Account": { + "$ref": "./examples/CreateAccount.json" + }, + "Create Account Min": { + "$ref": "./examples/CreateAccountMin.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/Account" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Accounts_Update", + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Updates a Cognitive Services account", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "account", + "in": "body", + "description": "The parameters to provide for the created account.", + "required": true, + "schema": { + "$ref": "#/definitions/Account" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/Account" + }, + "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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Account": { + "$ref": "./examples/UpdateAccount.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/Account" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Accounts_Delete", + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Deletes a Cognitive Services account from the resource group.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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 does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Account": { + "$ref": "./examples/DeleteAccount.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/capabilityHosts": { + "get": { + "operationId": "AccountCapabilityHosts_List", + "tags": [ + "AccountCapabilityHost" + ], + "summary": "List capabilityHost.", + "description": "List capabilityHost.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CapabilityHostResourceArmPaginatedResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Account CapabilityHosts.": { + "$ref": "./examples/AccountCapabilityHost/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/capabilityHosts/{capabilityHostName}": { + "get": { + "operationId": "AccountCapabilityHosts_Get", + "tags": [ + "AccountCapabilityHost" + ], + "summary": "Get account capabilityHost.", + "description": "Get account capabilityHost.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "capabilityHostName", + "in": "path", + "description": "The name of the capability host associated with the Cognitive Services Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CapabilityHost" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Account CapabilityHost.": { + "$ref": "./examples/AccountCapabilityHost/get.json" + } + } + }, + "put": { + "operationId": "AccountCapabilityHosts_CreateOrUpdate", + "tags": [ + "AccountCapabilityHost" + ], + "summary": "Create or update account capabilityHost.", + "description": "Create or update account capabilityHost.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "capabilityHostName", + "in": "path", + "description": "The name of the capability host associated with the Cognitive Services Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "name": "capabilityHost", + "in": "body", + "description": "CapabilityHost definition.", + "required": true, + "schema": { + "$ref": "#/definitions/CapabilityHost" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CapabilityHost" + } + }, + "201": { + "description": "Resource 'CapabilityHost' create operation succeeded", + "schema": { + "$ref": "#/definitions/CapabilityHost" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "x-ms-async-operation-timeout": { + "type": "string", + "format": "duration", + "description": "Timeout for the client to use when polling the asynchronous operation." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Account CapabilityHost.": { + "$ref": "./examples/AccountCapabilityHost/createOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri", + "final-state-schema": "#/definitions/CapabilityHost" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "AccountCapabilityHosts_Delete", + "tags": [ + "AccountCapabilityHost" + ], + "summary": "Delete account capabilityHost.", + "description": "Delete account capabilityHost.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "capabilityHostName", + "in": "path", + "description": "The name of the capability host associated with the Cognitive Services Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + } + ], + "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." + }, + "x-ms-async-operation-timeout": { + "type": "string", + "format": "duration", + "description": "Timeout for the client to use when polling the asynchronous operation." + } + } + }, + "204": { + "description": "There is no content to send for this request, but the headers may be useful." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Account CapabilityHost.": { + "$ref": "./examples/AccountCapabilityHost/delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/commitmentPlans": { + "get": { + "operationId": "CommitmentPlans_List", + "tags": [ + "CommitmentPlans" + ], + "description": "Gets the commitmentPlans associated with the Cognitive Services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CommitmentPlanListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListCommitmentPlans": { + "$ref": "./examples/ListCommitmentPlans.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/commitmentPlans/{commitmentPlanName}": { + "get": { + "operationId": "CommitmentPlans_Get", + "tags": [ + "CommitmentPlans" + ], + "description": "Gets the specified commitmentPlans associated with the Cognitive Services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "commitmentPlanName", + "in": "path", + "description": "The name of the commitmentPlan associated with the Cognitive Services Account", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetCommitmentPlan": { + "$ref": "./examples/GetCommitmentPlan.json" + } + } + }, + "put": { + "operationId": "CommitmentPlans_CreateOrUpdate", + "tags": [ + "CommitmentPlans" + ], + "description": "Update the state of specified commitmentPlans associated with the Cognitive Services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "commitmentPlanName", + "in": "path", + "description": "The name of the commitmentPlan associated with the Cognitive Services Account", + "required": true, + "type": "string" + }, + { + "name": "commitmentPlan", + "in": "body", + "description": "The commitmentPlan properties.", + "required": true, + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CommitmentPlan' update operation succeeded", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "201": { + "description": "Resource 'CommitmentPlan' create operation succeeded", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PutCommitmentPlan": { + "$ref": "./examples/PutCommitmentPlan.json" + } + } + }, + "delete": { + "operationId": "CommitmentPlans_Delete", + "tags": [ + "CommitmentPlans" + ], + "description": "Deletes the specified commitmentPlan associated with the Cognitive Services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "commitmentPlanName", + "in": "path", + "description": "The name of the commitmentPlan associated with the Cognitive Services Account", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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 does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteCommitmentPlan": { + "$ref": "./examples/DeleteCommitmentPlan.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/connections": { + "get": { + "operationId": "AccountConnections_List", + "tags": [ + "AccountConnectionResource" + ], + "summary": "Lists all the available Cognitive Services account connections under the specified account.", + "description": "Lists all the available Cognitive Services account connections under the specified account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "target", + "in": "query", + "description": "Target of the connection.", + "required": false, + "type": "string" + }, + { + "name": "category", + "in": "query", + "description": "Category of the connection.", + "required": false, + "type": "string" + }, + { + "name": "includeAll", + "in": "query", + "description": "query parameter that indicates if get connection call should return both connections and datastores", + "required": false, + "type": "boolean", + "default": false + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ConnectionPropertiesV2BasicResourceArmPaginatedResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListAccountConnections": { + "$ref": "./examples/AccountConnection/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/connections/{connectionName}": { + "get": { + "operationId": "AccountConnections_Get", + "tags": [ + "AccountConnectionResource" + ], + "summary": "Lists Cognitive Services account connection by name.", + "description": "Lists Cognitive Services account connection by name.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "connectionName", + "in": "path", + "description": "Friendly name of the connection", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetAccountConnection": { + "$ref": "./examples/AccountConnection/get.json" + } + } + }, + "put": { + "operationId": "AccountConnections_Create", + "tags": [ + "AccountConnectionResource" + ], + "summary": "Create or update Cognitive Services account connection under the specified account.", + "description": "Create or update Cognitive Services account connection under the specified account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "connectionName", + "in": "path", + "description": "Friendly name of the connection", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + { + "name": "connection", + "in": "body", + "description": "The object for creating or updating a new account connection", + "required": false, + "schema": { + "$ref": "#/definitions/ConnectionPropertiesV2BasicResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ConnectionPropertiesV2BasicResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/ConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateAccountConnection": { + "$ref": "./examples/AccountConnection/create.json" + } + } + }, + "patch": { + "operationId": "AccountConnections_Update", + "tags": [ + "AccountConnectionResource" + ], + "summary": "Update Cognitive Services account connection under the specified account.", + "description": "Update Cognitive Services account connection under the specified account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "connectionName", + "in": "path", + "description": "Friendly name of the connection", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + { + "name": "connection", + "in": "body", + "description": "Parameters for account connection update.", + "required": false, + "schema": { + "$ref": "#/definitions/ConnectionUpdateContent" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateAccountConnection": { + "$ref": "./examples/AccountConnection/update.json" + } + } + }, + "delete": { + "operationId": "AccountConnections_Delete", + "tags": [ + "AccountConnectionResource" + ], + "summary": "Delete Cognitive Services account connection by name.", + "description": "Delete Cognitive Services account connection by name.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "connectionName", + "in": "path", + "description": "Friendly name of the connection", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + } + ], + "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": { + "DeleteAccountConnection": { + "$ref": "./examples/AccountConnection/delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/defenderForAISettings": { + "get": { + "operationId": "DefenderForAISettings_List", + "tags": [ + "DefenderForAISettings" + ], + "description": "Lists the Defender for AI settings.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DefenderForAISettingResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListDefenderForAISetting": { + "$ref": "./examples/ListDefenderForAISetting.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/defenderForAISettings/{defenderForAISettingName}": { + "get": { + "operationId": "DefenderForAISettings_Get", + "tags": [ + "DefenderForAISettings" + ], + "description": "Gets the specified Defender for AI setting by name.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "defenderForAISettingName", + "in": "path", + "description": "The name of the defender for AI setting.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetDefenderForAISetting": { + "$ref": "./examples/GetDefenderForAISetting.json" + } + } + }, + "put": { + "operationId": "DefenderForAISettings_CreateOrUpdate", + "tags": [ + "DefenderForAISettings" + ], + "description": "Creates or Updates the specified Defender for AI setting.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "defenderForAISettingName", + "in": "path", + "description": "The name of the defender for AI setting.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "defenderForAISettings", + "in": "body", + "description": "Properties describing the Defender for AI setting.", + "required": true, + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + } + } + ], + "responses": { + "200": { + "description": "Resource 'DefenderForAISetting' update operation succeeded", + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + } + }, + "201": { + "description": "Resource 'DefenderForAISetting' create operation succeeded", + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PutDefenderForAISetting": { + "$ref": "./examples/PutDefenderForAISetting.json" + } + } + }, + "patch": { + "operationId": "DefenderForAISettings_Update", + "tags": [ + "DefenderForAISettings" + ], + "description": "Updates the specified Defender for AI setting.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "defenderForAISettingName", + "in": "path", + "description": "The name of the defender for AI setting.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "defenderForAISettings", + "in": "body", + "description": "Properties describing the Defender for AI setting.", + "required": true, + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DefenderForAISetting" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateDefenderForAISetting": { + "$ref": "./examples/UpdateDefenderForAISetting.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments": { + "get": { + "operationId": "Deployments_List", + "tags": [ + "Deployments" + ], + "description": "Gets the deployments associated with the Cognitive Services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DeploymentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListDeployments": { + "$ref": "./examples/ListDeployments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}": { + "get": { + "operationId": "Deployments_Get", + "tags": [ + "Deployments" + ], + "description": "Gets the specified deployments associated with the Cognitive Services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the deployment associated with the Cognitive Services Account", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetDeployment": { + "$ref": "./examples/GetDeployment.json" + } + } + }, + "put": { + "operationId": "Deployments_CreateOrUpdate", + "tags": [ + "Deployments" + ], + "description": "Update the state of specified deployments associated with the Cognitive Services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the deployment associated with the Cognitive Services Account", + "required": true, + "type": "string" + }, + { + "name": "deployment", + "in": "body", + "description": "The deployment properties.", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Deployment' update operation succeeded", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "201": { + "description": "Resource 'Deployment' create operation succeeded", + "schema": { + "$ref": "#/definitions/Deployment" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PutDeployment": { + "$ref": "./examples/PutDeployment.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation", + "final-state-schema": "#/definitions/Deployment" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Deployments_Update", + "tags": [ + "Deployments" + ], + "description": "Update specified deployments associated with the Cognitive Services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the deployment associated with the Cognitive Services Account", + "required": true, + "type": "string" + }, + { + "name": "deployment", + "in": "body", + "description": "The deployment properties.", + "required": true, + "schema": { + "$ref": "#/definitions/PatchResourceTagsAndSku" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateDeployment": { + "$ref": "./examples/UpdateDeployment.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/Deployment" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Deployments_Delete", + "tags": [ + "Deployments" + ], + "description": "Deletes the specified deployment associated with the Cognitive Services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the deployment associated with the Cognitive Services Account", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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 does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteDeployment": { + "$ref": "./examples/DeleteDeployment.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}/pause": { + "post": { + "operationId": "Deployments_Pause", + "tags": [ + "Deployments" + ], + "summary": "Pause a deployment", + "description": "Pauses inferencing on a deployment by setting the deploymentState to 'Paused' (see #/definitions/DeploymentProperties/properties/deploymentState). Only Standard, DataZoneStandard, and GlobalStandard SKUs support this operation. Inference requests to the paused deployment endpoint will receive HTTP 423 (Locked). This operation is idempotent.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the deployment associated with the Cognitive Services Account", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PauseDeployment": { + "$ref": "./examples/PauseDeployment.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}/resume": { + "post": { + "operationId": "Deployments_Resume", + "tags": [ + "Deployments" + ], + "summary": "Resume a deployment", + "description": "Resumes inferencing on a previously paused deployment by setting the deploymentState to 'Running' (see #/definitions/DeploymentProperties/properties/deploymentState). This operation is idempotent and can be safely called on already running deployments.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the deployment associated with the Cognitive Services Account", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ResumeDeployment": { + "$ref": "./examples/ResumeDeployment.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}/skus": { + "get": { + "operationId": "Deployments_ListSkus", + "tags": [ + "Deployments" + ], + "description": "Lists the specified deployments skus associated with the Cognitive Services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the deployment associated with the Cognitive Services Account", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeploymentSkuListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListDeploymentSkus": { + "$ref": "./examples/ListDeploymentSkus.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/encryptionScopes": { + "get": { + "operationId": "EncryptionScopes_List", + "tags": [ + "EncryptionScopes" + ], + "description": "Gets the content filters associated with the Azure OpenAI account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EncryptionScopeListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListEncryptionScopes": { + "$ref": "./examples/ListEncryptionScopes.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/encryptionScopes/{encryptionScopeName}": { + "get": { + "operationId": "EncryptionScopes_Get", + "tags": [ + "EncryptionScopes" + ], + "description": "Gets the specified EncryptionScope associated with the Cognitive Services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "encryptionScopeName", + "in": "path", + "description": "The name of the encryptionScope associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EncryptionScope" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetEncryptionScope": { + "$ref": "./examples/GetEncryptionScope.json" + } + } + }, + "put": { + "operationId": "EncryptionScopes_CreateOrUpdate", + "tags": [ + "EncryptionScopes" + ], + "description": "Update the state of specified encryptionScope associated with the Cognitive Services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "encryptionScopeName", + "in": "path", + "description": "The name of the encryptionScope associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "encryptionScope", + "in": "body", + "description": "The encryptionScope properties.", + "required": true, + "schema": { + "$ref": "#/definitions/EncryptionScope" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EncryptionScope' update operation succeeded", + "schema": { + "$ref": "#/definitions/EncryptionScope" + } + }, + "201": { + "description": "Resource 'EncryptionScope' create operation succeeded", + "schema": { + "$ref": "#/definitions/EncryptionScope" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PutEncryptionScope": { + "$ref": "./examples/PutEncryptionScope.json" + } + } + }, + "delete": { + "operationId": "EncryptionScopes_Delete", + "tags": [ + "EncryptionScopes" + ], + "description": "Deletes the specified encryptionScope associated with the Cognitive Services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "encryptionScopeName", + "in": "path", + "description": "The name of the encryptionScope associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "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 does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteEncryptionScope": { + "$ref": "./examples/DeleteEncryptionScope.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/listKeys": { + "post": { + "operationId": "Accounts_ListKeys", + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Lists the account keys for the specified Cognitive Services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiKeys" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Keys": { + "$ref": "./examples/ListKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/managedNetworks": { + "get": { + "operationId": "ManagedNetworkSettings_List", + "tags": [ + "ManagedNetwork" + ], + "summary": "List API for managed network settings of a cognitive services account.", + "description": "List API for managed network settings of a cognitive services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedNetworkListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List ManagedNetworkSettings": { + "$ref": "./examples/ManagedNetwork/listManagedNetworkV2.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/managedNetworks/{managedNetworkName}": { + "get": { + "operationId": "ManagedNetworkSettings_Get", + "tags": [ + "ManagedNetwork" + ], + "summary": "Get API for managed network settings of a cognitive services account.", + "description": "Get API for managed network settings of a cognitive services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "managedNetworkName", + "in": "path", + "description": "Name of the managedNetwork associated with the cognitive services account. Only 'default' is supported.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedNetworkSettingsPropertiesBasicResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get ManagedNetworkSettings": { + "$ref": "./examples/ManagedNetwork/getManagedNetworkV2.json" + } + } + }, + "put": { + "operationId": "ManagedNetworkSettings_Put", + "tags": [ + "ManagedNetwork" + ], + "summary": "PUT API for managed network settings of a cognitive services account.", + "description": "PUT API for managed network settings of a cognitive services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "managedNetworkName", + "in": "path", + "description": "Name of the managedNetwork associated with the cognitive services account. Only 'default' is supported.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + { + "name": "body", + "in": "body", + "description": "The Managed Network Settings object of the account.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedNetworkSettingsPropertiesBasicResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ManagedNetworkSettingsPropertiesBasicResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/ManagedNetworkSettingsPropertiesBasicResource" + } + }, + "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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Put ManagedNetworkSettings": { + "$ref": "./examples/ManagedNetwork/createOrUpdateManagedNetworkV2.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/ManagedNetworkSettingsPropertiesBasicResource" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ManagedNetworkSettings_Patch", + "tags": [ + "ManagedNetwork" + ], + "summary": "Patch API for managed network settings of a cognitive services account.", + "description": "Patch API for managed network settings of a cognitive services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "managedNetworkName", + "in": "path", + "description": "Name of the managedNetwork associated with the cognitive services account. Only 'default' is supported.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + { + "name": "body", + "in": "body", + "description": "The Managed Network Settings object of the account.", + "required": false, + "schema": { + "$ref": "#/definitions/ManagedNetworkSettingsPropertiesBasicResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedNetworkSettingsPropertiesBasicResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch ManagedNetworkSettings": { + "$ref": "./examples/ManagedNetwork/patchManagedNetworkV2.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/ManagedNetworkSettingsPropertiesBasicResource" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ManagedNetworkSettings_Delete", + "tags": [ + "ManagedNetwork" + ], + "summary": "Delete API for managed network settings of a cognitive services account.", + "description": "Delete API for managed network settings of a cognitive services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "managedNetworkName", + "in": "path", + "description": "Name of the managedNetwork associated with the cognitive services account. Only 'default' is supported.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + } + ], + "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 does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete ManagedNetworkSettings": { + "$ref": "./examples/ManagedNetwork/deleteManagedNetworkV2.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/managedNetworks/{managedNetworkName}/batchOutboundRules": { + "post": { + "operationId": "OutboundRules_Post", + "tags": [ + "ManagedNetwork" + ], + "summary": "The POST API for updating the outbound rules of the managed network associated with the cognitive services account.", + "description": "The POST API for updating the outbound rules of the managed network associated with the cognitive services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "managedNetworkName", + "in": "path", + "description": "Name of the managedNetwork associated with the cognitive services account. Only 'default' is supported.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + { + "name": "body", + "in": "body", + "description": "The Managed Network Settings object of the account.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedNetworkSettingsBasicResource" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OutboundRuleListResult" + } + }, + "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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Post OutboundRules": { + "$ref": "./examples/ManagedNetwork/postOutboundRulesV2.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/OutboundRuleListResult" + }, + "x-ms-long-running-operation": true, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/managedNetworks/{managedNetworkName}/outboundRules": { + "get": { + "operationId": "OutboundRule_List", + "tags": [ + "ManagedNetwork" + ], + "summary": "The GET API for retrieving the list of outbound rules of the managed network associated with the cognitive services account.", + "description": "The GET API for retrieving the list of outbound rules of the managed network associated with the cognitive services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "managedNetworkName", + "in": "path", + "description": "Name of the managedNetwork associated with the cognitive services account. Only 'default' is supported.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/OutboundRuleListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List OutboundRules": { + "$ref": "./examples/ManagedNetwork/listRuleV2.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/managedNetworks/{managedNetworkName}/outboundRules/{ruleName}": { + "get": { + "operationId": "OutboundRule_Get", + "tags": [ + "ManagedNetwork" + ], + "summary": "The GET API for retrieving a single outbound rule of the managed network associated with the cognitive services account.", + "description": "The GET API for retrieving a single outbound rule of the managed network associated with the cognitive services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "managedNetworkName", + "in": "path", + "description": "Name of the managedNetwork associated with the cognitive services account. Only 'default' is supported.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + { + "name": "ruleName", + "in": "path", + "description": "Name of the cognitive services account managed network outbound rule", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get OutboundRule": { + "$ref": "./examples/ManagedNetwork/getRuleV2.json" + } + } + }, + "put": { + "operationId": "OutboundRule_CreateOrUpdate", + "tags": [ + "ManagedNetwork" + ], + "summary": "The PUT API for creating or updating a single outbound rule of the managed network associated with the cognitive services account.", + "description": "The PUT API for creating or updating a single outbound rule of the managed network associated with the cognitive services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "managedNetworkName", + "in": "path", + "description": "Name of the managedNetwork associated with the cognitive services account. Only 'default' is supported.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + { + "name": "ruleName", + "in": "path", + "description": "Name of the cognitive services account managed network outbound rule", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + { + "name": "body", + "in": "body", + "description": "", + "required": true, + "schema": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'OutboundRuleBasicResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + }, + "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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate OutboundRule": { + "$ref": "./examples/ManagedNetwork/createOrUpdateRuleV2.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/OutboundRuleBasicResource" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "OutboundRule_Delete", + "tags": [ + "ManagedNetwork" + ], + "summary": "The DELETE API for deleting a single outbound rule of the managed network associated with the cognitive services account.", + "description": "The DELETE API for deleting a single outbound rule of the managed network associated with the cognitive services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "managedNetworkName", + "in": "path", + "description": "Name of the managedNetwork associated with the cognitive services account. Only 'default' is supported.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + { + "name": "ruleName", + "in": "path", + "description": "Name of the cognitive services account managed network outbound rule", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + } + ], + "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 does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete OutboundRule": { + "$ref": "./examples/ManagedNetwork/deleteRuleV2.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/managedNetworks/{managedNetworkName}/provision": { + "post": { + "operationId": "ManagedNetworkProvisions_ProvisionManagedNetwork", + "tags": [ + "ManagedNetwork" + ], + "summary": "Provisions the managed network of a cognitive services account.", + "description": "Provisions the managed network of a cognitive services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "managedNetworkName", + "in": "path", + "description": "Name of the managedNetwork associated with the cognitive services account. Only 'default' is supported.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + { + "name": "body", + "in": "body", + "description": "Managed Network Provisioning Options for a cognitive services account.", + "required": false, + "schema": { + "$ref": "#/definitions/ManagedNetworkProvisionOptions" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedNetworkProvisionStatus" + } + }, + "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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Provision ManagedNetwork": { + "$ref": "./examples/ManagedNetwork/provisionManagedNetwork.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/ManagedNetworkProvisionStatus" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/models": { + "get": { + "operationId": "Accounts_ListModels", + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "List available Models for the requested Cognitive Services account", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccountModelListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List AccountModels": { + "$ref": "./examples/ListAccountModels.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/networkSecurityPerimeterConfigurations": { + "get": { + "operationId": "NetworkSecurityPerimeterConfigurations_List", + "tags": [ + "NetworkSecurityPerimeterConfigurations" + ], + "description": "Gets a list of NSP configurations for an account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListNetworkSecurityPerimeterConfigurations": { + "$ref": "./examples/ListNetworkSecurityPerimeterConfigurations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/networkSecurityPerimeterConfigurations/{nspConfigurationName}": { + "get": { + "operationId": "NetworkSecurityPerimeterConfigurations_Get", + "tags": [ + "NetworkSecurityPerimeterConfigurations" + ], + "description": "Gets the specified NSP configurations for an account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "nspConfigurationName", + "in": "path", + "description": "The name of the NSP Configuration.", + "required": true, + "type": "string", + "pattern": "^.*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfiguration" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetNetworkSecurityPerimeterConfigurations": { + "$ref": "./examples/GetNetworkSecurityPerimeterConfigurations.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/networkSecurityPerimeterConfigurations/{nspConfigurationName}/reconcile": { + "post": { + "operationId": "NetworkSecurityPerimeterConfigurations_Reconcile", + "tags": [ + "NetworkSecurityPerimeterConfigurations" + ], + "description": "Reconcile the NSP configuration for an account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "nspConfigurationName", + "in": "path", + "description": "The name of the NSP Configuration.", + "required": true, + "type": "string", + "pattern": "^.*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfiguration" + } + }, + "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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ReconcileNetworkSecurityPerimeterConfigurations": { + "$ref": "./examples/ReconcileNetworkSecurityPerimeterConfigurations.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/NetworkSecurityPerimeterConfiguration" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateEndpointConnections": { + "get": { + "operationId": "PrivateEndpointConnections_List", + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets the private endpoint connections associated with the Cognitive Services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetPrivateEndpointConnection": { + "$ref": "./examples/ListPrivateEndpointConnections.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "operationId": "PrivateEndpointConnections_Get", + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets the specified private endpoint connection associated with the Cognitive Services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection associated with the Cognitive Services Account", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetPrivateEndpointConnection": { + "$ref": "./examples/GetPrivateEndpointConnection.json" + } + } + }, + "put": { + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Update the state of specified private endpoint connection associated with the Cognitive Services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection associated with the Cognitive Services Account", + "required": true, + "type": "string" + }, + { + "name": "properties", + "in": "body", + "description": "The private endpoint connection properties.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Resource 'PrivateEndpointConnection' update operation succeeded", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PutPrivateEndpointConnection": { + "$ref": "./examples/PutPrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/PrivateEndpointConnection" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "PrivateEndpointConnections_Delete", + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Deletes the specified private endpoint connection associated with the Cognitive Services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection associated with the Cognitive Services Account", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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 does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeletePrivateEndpointConnection": { + "$ref": "./examples/DeletePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/privateLinkResources": { + "get": { + "operationId": "PrivateLinkResources_List", + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets the private link resources that need to be created for a Cognitive Services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListPrivateLinkResources": { + "$ref": "./examples/ListPrivateLinkResources.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects": { + "get": { + "operationId": "Projects_List", + "tags": [ + "CognitiveServicesProjects" + ], + "description": "Returns all the projects in a Cognitive Services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Project": { + "$ref": "./examples/ListProjects.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}": { + "get": { + "operationId": "Projects_Get", + "tags": [ + "CognitiveServicesProjects" + ], + "description": "Returns a Cognitive Services project specified by the parameters.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Project": { + "$ref": "./examples/GetProject.json" + } + } + }, + "put": { + "operationId": "Projects_Create", + "tags": [ + "CognitiveServicesProjects" + ], + "description": "Create Cognitive Services Account's Project. Project is a sub-resource of an account which give AI developer it's individual container to work on.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "project", + "in": "body", + "description": "The parameters to provide for the created project.", + "required": true, + "schema": { + "$ref": "#/definitions/Project" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Project' update operation succeeded", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "201": { + "description": "Resource 'Project' create operation succeeded", + "schema": { + "$ref": "#/definitions/Project" + }, + "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." + } + } + }, + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/Project" + }, + "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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create Project": { + "$ref": "./examples/CreateProject.json" + }, + "Create Project Min": { + "$ref": "./examples/CreateProjectMin.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/Project" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Projects_Update", + "tags": [ + "CognitiveServicesProjects" + ], + "description": "Updates a Cognitive Services Project", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "project", + "in": "body", + "description": "The parameters to provide for the created project.", + "required": true, + "schema": { + "$ref": "#/definitions/Project" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/Project" + }, + "headers": { + "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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Project": { + "$ref": "./examples/UpdateProjects.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/Project" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Projects_Delete", + "tags": [ + "CognitiveServicesProjects" + ], + "description": "Deletes a Cognitive Services project from the resource group.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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 does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Project": { + "$ref": "./examples/DeleteProject.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications": { + "get": { + "operationId": "AgentApplications_List", + "tags": [ + "AgentApplication" + ], + "summary": "Lists Agent Applications in the project.", + "description": "Lists Agent Applications in the project.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "count", + "in": "query", + "description": "Number of agent applications to be retrieved in a page of results.", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of agent applications to skip.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$skipToken", + "in": "query", + "description": "Continuation token for pagination.", + "required": false, + "type": "string" + }, + { + "name": "names", + "in": "query", + "description": "Names of agent applications to retrieve.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "searchText", + "in": "query", + "description": "Search text for filtering agent applications.", + "required": false, + "type": "string" + }, + { + "name": "orderBy", + "in": "query", + "description": "Field to order by.", + "required": false, + "type": "string" + }, + { + "name": "orderByAsc", + "in": "query", + "description": "Whether to order in ascending order.", + "required": false, + "type": "boolean", + "default": false + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AgentApplicationResourceArmPaginatedResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Account Agent Applications.": { + "$ref": "./examples/AgentApplication/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{name}": { + "get": { + "operationId": "AgentApplications_Get", + "tags": [ + "AgentApplication" + ], + "summary": "Gets an Agent Application by name.", + "description": "Gets an Agent Application by name.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "name", + "in": "path", + "description": "Name for the Agent Application.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AgentApplication" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Account Agent Application.": { + "$ref": "./examples/AgentApplication/get.json" + } + } + }, + "put": { + "operationId": "AgentApplications_CreateOrUpdate", + "tags": [ + "AgentApplication" + ], + "summary": "Creates or updates an Agent Application (asynchronous).", + "description": "Creates or updates an Agent Application (asynchronous).", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "name", + "in": "path", + "description": "Name for the Agent Application.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "Agent Application definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/AgentApplication" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AgentApplication" + } + }, + "201": { + "description": "Resource 'AgentApplication' create operation succeeded", + "schema": { + "$ref": "#/definitions/AgentApplication" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for asynchronous operation status." + }, + "location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "x-ms-async-operation-timeout": { + "type": "string", + "format": "duration", + "description": "Timeout for the client to use when polling the asynchronous operation." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update Account Agent Application.": { + "$ref": "./examples/AgentApplication/createOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/AgentApplication" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "AgentApplications_Delete", + "tags": [ + "AgentApplication" + ], + "summary": "Delete Agent Application.", + "description": "Delete Agent Application.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "name", + "in": "path", + "description": "Name for the Agent Application.", + "required": true, + "type": "string" + } + ], + "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 does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Account Agent Application.": { + "$ref": "./examples/AgentApplication/delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{appName}/agentDeployments": { + "get": { + "operationId": "AgentDeployments_List", + "tags": [ + "AgentDeployment" + ], + "summary": "Lists Agent Deployments in the application.", + "description": "Lists Agent Deployments in the application.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "appName", + "in": "path", + "description": "The name of the application associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "count", + "in": "query", + "description": "Number of agent deployments to be retrieved in a page of results.", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "$skipToken", + "in": "query", + "description": "Continuation token for pagination.", + "required": false, + "type": "string" + }, + { + "name": "names", + "in": "query", + "description": "Names of agent deployments to retrieve.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "orderBy", + "in": "query", + "description": "Field to order by.", + "required": false, + "type": "string" + }, + { + "name": "orderByAsc", + "in": "query", + "description": "Whether to order in ascending order.", + "required": false, + "type": "boolean", + "default": false + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AgentDeploymentResourceArmPaginatedResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Agent Deployments.": { + "$ref": "./examples/AgentDeployment/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{appName}/agentDeployments/{deploymentName}": { + "get": { + "operationId": "AgentDeployments_Get", + "tags": [ + "AgentDeployment" + ], + "summary": "Gets an Agent Deployment by name.", + "description": "Gets an Agent Deployment by name.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "appName", + "in": "path", + "description": "The name of the application associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the deployment associated with the Cognitive Services Account", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AgentDeployment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Agent Deployment.": { + "$ref": "./examples/AgentDeployment/get.json" + } + } + }, + "put": { + "operationId": "AgentDeployments_CreateOrUpdate", + "tags": [ + "AgentDeployment" + ], + "summary": "Creates or updates an Agent Deployment (asynchronous).", + "description": "Creates or updates an Agent Deployment (asynchronous).", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "appName", + "in": "path", + "description": "The name of the application associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the deployment associated with the Cognitive Services Account", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "Agent Deployment definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/AgentDeployment" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AgentDeployment" + } + }, + "201": { + "description": "Resource 'AgentDeployment' create operation succeeded", + "schema": { + "$ref": "#/definitions/AgentDeployment" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for asynchronous operation status." + }, + "location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "x-ms-async-operation-timeout": { + "type": "string", + "format": "duration", + "description": "Timeout for the client to use when polling the asynchronous operation." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update Agent Deployment.": { + "$ref": "./examples/AgentDeployment/createOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/AgentDeployment" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "AgentDeployments_Delete", + "tags": [ + "AgentDeployment" + ], + "summary": "Delete Agent Deployment.", + "description": "Delete Agent Deployment.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "appName", + "in": "path", + "description": "The name of the application associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the deployment associated with the Cognitive Services Account", + "required": true, + "type": "string" + } + ], + "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 does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Agent Deployment.": { + "$ref": "./examples/AgentDeployment/delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{appName}/agentDeployments/{deploymentName}/start": { + "post": { + "operationId": "AgentDeployments_Start", + "tags": [ + "AgentDeployment" + ], + "summary": "Starts an Agent Deployment.", + "description": "Starts an Agent Deployment.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "appName", + "in": "path", + "description": "The name of the application associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the deployment associated with the Cognitive Services Account", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Start Agent Deployment.": { + "$ref": "./examples/AgentDeployment/start.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{appName}/agentDeployments/{deploymentName}/stop": { + "post": { + "operationId": "AgentDeployments_Stop", + "tags": [ + "AgentDeployment" + ], + "summary": "Stops an Agent Deployment.", + "description": "Stops an Agent Deployment.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "appName", + "in": "path", + "description": "The name of the application associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the deployment associated with the Cognitive Services Account", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Stop Agent Deployment.": { + "$ref": "./examples/AgentDeployment/stop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{name}/disable": { + "post": { + "operationId": "AgentApplications_Disable", + "tags": [ + "AgentApplication" + ], + "summary": "Disables an Agent Application.", + "description": "Disables an Agent Application.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "name", + "in": "path", + "description": "Name for the Agent Application.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Disable Agent Application.": { + "$ref": "./examples/AgentApplication/disable.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{name}/enable": { + "post": { + "operationId": "AgentApplications_Enable", + "tags": [ + "AgentApplication" + ], + "summary": "Enables an Agent Application.", + "description": "Enables an Agent Application.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "name", + "in": "path", + "description": "Name for the Agent Application.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Enable Agent Application.": { + "$ref": "./examples/AgentApplication/enable.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{name}/listAgents": { + "post": { + "operationId": "AgentApplications_ListAgents", + "tags": [ + "AgentApplication" + ], + "summary": "Lists agents for an Agent Application.", + "description": "Lists agents for an Agent Application.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "name", + "in": "path", + "description": "Name for the Agent Application.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AgentReferenceResourceArmPaginatedResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Agents for Agent Application.": { + "$ref": "./examples/AgentApplication/listAgents.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/capabilityHosts": { + "get": { + "operationId": "ProjectCapabilityHosts_List", + "tags": [ + "ProjectCapabilityHost" + ], + "summary": "List capabilityHost.", + "description": "List capabilityHost.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ProjectCapabilityHostResourceArmPaginatedResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Project CapabilityHosts.": { + "$ref": "./examples/ProjectCapabilityHost/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/capabilityHosts/{capabilityHostName}": { + "get": { + "operationId": "ProjectCapabilityHosts_Get", + "tags": [ + "ProjectCapabilityHost" + ], + "summary": "Get project capabilityHost.", + "description": "Get project capabilityHost.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "capabilityHostName", + "in": "path", + "description": "The name of the capability host associated with the Cognitive Services Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ProjectCapabilityHost" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Project CapabilityHost.": { + "$ref": "./examples/ProjectCapabilityHost/get.json" + } + } + }, + "put": { + "operationId": "ProjectCapabilityHosts_CreateOrUpdate", + "tags": [ + "ProjectCapabilityHost" + ], + "summary": "Create or update project capabilityHost.", + "description": "Create or update project capabilityHost.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "capabilityHostName", + "in": "path", + "description": "The name of the capability host associated with the Cognitive Services Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "name": "capabilityHost", + "in": "body", + "description": "CapabilityHost definition.", + "required": true, + "schema": { + "$ref": "#/definitions/ProjectCapabilityHost" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ProjectCapabilityHost" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/ProjectCapabilityHost" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "x-ms-async-operation-timeout": { + "type": "string", + "format": "duration", + "description": "Timeout for the client to use when polling the asynchronous operation." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Project CapabilityHost.": { + "$ref": "./examples/ProjectCapabilityHost/createOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri", + "final-state-schema": "#/definitions/ProjectCapabilityHost" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ProjectCapabilityHosts_Delete", + "tags": [ + "ProjectCapabilityHost" + ], + "summary": "Delete project capabilityHost.", + "description": "Delete project capabilityHost.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "capabilityHostName", + "in": "path", + "description": "The name of the capability host associated with the Cognitive Services Resource", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + } + ], + "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." + }, + "x-ms-async-operation-timeout": { + "type": "string", + "format": "duration", + "description": "Timeout for the client to use when polling the asynchronous operation." + } + } + }, + "204": { + "description": "There is no content to send for this request, but the headers may be useful." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Project CapabilityHost.": { + "$ref": "./examples/ProjectCapabilityHost/delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/connections": { + "get": { + "operationId": "ProjectConnections_List", + "tags": [ + "ProjectConnectionResource" + ], + "summary": "Lists all the available Cognitive Services project connections under the specified project.", + "description": "Lists all the available Cognitive Services project connections under the specified project.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "target", + "in": "query", + "description": "Target of the connection.", + "required": false, + "type": "string" + }, + { + "name": "category", + "in": "query", + "description": "Category of the connection.", + "required": false, + "type": "string" + }, + { + "name": "includeAll", + "in": "query", + "description": "query parameter that indicates if get connection call should return both connections and datastores", + "required": false, + "type": "boolean", + "default": false + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ConnectionPropertiesV2BasicResourceArmPaginatedResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListProjectConnection": { + "$ref": "./examples/ProjectConnection/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/connections/{connectionName}": { + "get": { + "operationId": "ProjectConnections_Get", + "tags": [ + "ProjectConnectionResource" + ], + "summary": "Lists Cognitive Services project connection by name.", + "description": "Lists Cognitive Services project connection by name.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "connectionName", + "in": "path", + "description": "Friendly name of the connection", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetProjectConnection": { + "$ref": "./examples/ProjectConnection/get.json" + } + } + }, + "put": { + "operationId": "ProjectConnections_Create", + "tags": [ + "ProjectConnectionResource" + ], + "summary": "Create or update Cognitive Services project connection under the specified project.", + "description": "Create or update Cognitive Services project connection under the specified project.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "connectionName", + "in": "path", + "description": "Friendly name of the connection", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + { + "name": "connection", + "in": "body", + "description": "The object for creating or updating a new account connection", + "required": false, + "schema": { + "$ref": "#/definitions/ConnectionPropertiesV2BasicResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ConnectionPropertiesV2BasicResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/ConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateProjectConnection": { + "$ref": "./examples/ProjectConnection/create.json" + } + } + }, + "patch": { + "operationId": "ProjectConnections_Update", + "tags": [ + "ProjectConnectionResource" + ], + "summary": "Update Cognitive Services project connection under the specified project.", + "description": "Update Cognitive Services project connection under the specified project.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "connectionName", + "in": "path", + "description": "Friendly name of the connection", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + { + "name": "connection", + "in": "body", + "description": "Parameters for account connection update.", + "required": false, + "schema": { + "$ref": "#/definitions/ConnectionUpdateContent" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateProjectConnection": { + "$ref": "./examples/ProjectConnection/update.json" + } + } + }, + "delete": { + "operationId": "ProjectConnections_Delete", + "tags": [ + "ProjectConnectionResource" + ], + "summary": "Delete Cognitive Services project connection by name.", + "description": "Delete Cognitive Services project connection by name.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of Cognitive Services account's project.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "connectionName", + "in": "path", + "description": "Friendly name of the connection", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + } + ], + "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": { + "DeleteProjectConnection": { + "$ref": "./examples/ProjectConnection/delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists": { + "get": { + "operationId": "RaiBlocklists_List", + "tags": [ + "RaiBlocklists" + ], + "description": "Gets the custom blocklists associated with the Azure OpenAI account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RaiBlockListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListBlocklists": { + "$ref": "./examples/ListBlocklists.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}": { + "get": { + "operationId": "RaiBlocklists_Get", + "tags": [ + "RaiBlocklists" + ], + "description": "Gets the specified custom blocklist associated with the Azure OpenAI account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiBlocklistName", + "in": "path", + "description": "The name of the RaiBlocklist associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklist" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetRaiBlocklist": { + "$ref": "./examples/GetRaiBlocklist.json" + } + } + }, + "put": { + "operationId": "RaiBlocklists_CreateOrUpdate", + "tags": [ + "RaiBlocklists" + ], + "description": "Update the state of specified blocklist associated with the Azure OpenAI account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiBlocklistName", + "in": "path", + "description": "The name of the RaiBlocklist associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiBlocklist", + "in": "body", + "description": "Properties describing the custom blocklist.", + "required": true, + "schema": { + "$ref": "#/definitions/RaiBlocklist" + } + } + ], + "responses": { + "200": { + "description": "Resource 'RaiBlocklist' update operation succeeded", + "schema": { + "$ref": "#/definitions/RaiBlocklist" + } + }, + "201": { + "description": "Resource 'RaiBlocklist' create operation succeeded", + "schema": { + "$ref": "#/definitions/RaiBlocklist" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PutRaiBlocklist": { + "$ref": "./examples/PutRaiBlocklist.json" + } + } + }, + "delete": { + "operationId": "RaiBlocklists_Delete", + "tags": [ + "RaiBlocklists" + ], + "description": "Deletes the specified custom blocklist associated with the Azure OpenAI account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiBlocklistName", + "in": "path", + "description": "The name of the RaiBlocklist associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "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 does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteRaiBlocklist": { + "$ref": "./examples/DeleteRaiBlocklist.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/addRaiBlocklistItems": { + "post": { + "operationId": "RaiBlocklistItems_BatchAdd", + "tags": [ + "RaiBlocklists" + ], + "description": "Batch operation to add blocklist items.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiBlocklistName", + "in": "path", + "description": "The name of the RaiBlocklist associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiBlocklistItems", + "in": "body", + "description": "Properties describing the custom blocklist items.", + "required": true, + "schema": { + "$ref": "#/definitions/RaiBlocklistItemsBulkAddRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklist" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AddRaiBlocklistItems": { + "$ref": "./examples/AddRaiBlocklistItems.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/deleteRaiBlocklistItems": { + "post": { + "operationId": "RaiBlocklistItems_BatchDelete", + "tags": [ + "RaiBlocklists" + ], + "description": "Batch operation to delete blocklist items.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiBlocklistName", + "in": "path", + "description": "The name of the RaiBlocklist associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiBlocklistItemsNames", + "in": "body", + "description": "List of RAI Blocklist Items Names.", + "required": true, + "schema": { + "$ref": "#/definitions/RaiBlocklistItemsBulkDeleteRequest" + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteRaiBlocklistItems": { + "$ref": "./examples/DeleteRaiBlocklistItems.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/raiBlocklistItems": { + "get": { + "operationId": "RaiBlocklistItems_List", + "tags": [ + "RaiBlocklists" + ], + "description": "Gets the blocklist items associated with the custom blocklist.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiBlocklistName", + "in": "path", + "description": "The name of the RaiBlocklist associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RaiBlockListItemsResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListBlocklistItems": { + "$ref": "./examples/ListBlocklistItems.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/raiBlocklistItems/{raiBlocklistItemName}": { + "get": { + "operationId": "RaiBlocklistItems_Get", + "tags": [ + "RaiBlocklists" + ], + "description": "Gets the specified custom blocklist Item associated with the custom blocklist.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiBlocklistName", + "in": "path", + "description": "The name of the RaiBlocklist associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiBlocklistItemName", + "in": "path", + "description": "The name of the RaiBlocklist Item associated with the custom blocklist", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RaiBlocklistItem" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetRaiBlocklistItem": { + "$ref": "./examples/GetRaiBlocklistItem.json" + } + } + }, + "put": { + "operationId": "RaiBlocklistItems_CreateOrUpdate", + "tags": [ + "RaiBlocklists" + ], + "description": "Update the state of specified blocklist item associated with the Azure OpenAI account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiBlocklistName", + "in": "path", + "description": "The name of the RaiBlocklist associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiBlocklistItemName", + "in": "path", + "description": "The name of the RaiBlocklist Item associated with the custom blocklist", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiBlocklistItem", + "in": "body", + "description": "Properties describing the custom blocklist.", + "required": true, + "schema": { + "$ref": "#/definitions/RaiBlocklistItem" + } + } + ], + "responses": { + "200": { + "description": "Resource 'RaiBlocklistItem' update operation succeeded", + "schema": { + "$ref": "#/definitions/RaiBlocklistItem" + } + }, + "201": { + "description": "Resource 'RaiBlocklistItem' create operation succeeded", + "schema": { + "$ref": "#/definitions/RaiBlocklistItem" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PutRaiBlocklistItem": { + "$ref": "./examples/PutRaiBlocklistItem.json" + } + } + }, + "delete": { + "operationId": "RaiBlocklistItems_Delete", + "tags": [ + "RaiBlocklists" + ], + "description": "Deletes the specified blocklist Item associated with the custom blocklist.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiBlocklistName", + "in": "path", + "description": "The name of the RaiBlocklist associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiBlocklistItemName", + "in": "path", + "description": "The name of the RaiBlocklist Item associated with the custom blocklist", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "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 does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteRaiBlocklistItem": { + "$ref": "./examples/DeleteRaiBlocklistItem.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiPolicies": { + "get": { + "operationId": "RaiPolicies_List", + "tags": [ + "RaiPolicies" + ], + "description": "Gets the content filters associated with the Azure OpenAI account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RaiPolicyListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListRaiPolicies": { + "$ref": "./examples/ListRaiPolicies.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiPolicies/{raiPolicyName}": { + "get": { + "operationId": "RaiPolicies_Get", + "tags": [ + "RaiPolicies" + ], + "description": "Gets the specified Content Filters associated with the Azure OpenAI account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiPolicyName", + "in": "path", + "description": "The name of the RaiPolicy associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RaiPolicy" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetRaiPolicy": { + "$ref": "./examples/GetRaiPolicy.json" + } + } + }, + "put": { + "operationId": "RaiPolicies_CreateOrUpdate", + "tags": [ + "RaiPolicies" + ], + "description": "Update the state of specified Content Filters associated with the Azure OpenAI account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiPolicyName", + "in": "path", + "description": "The name of the RaiPolicy associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiPolicy", + "in": "body", + "description": "Properties describing the Content Filters.", + "required": true, + "schema": { + "$ref": "#/definitions/RaiPolicy" + } + } + ], + "responses": { + "200": { + "description": "Resource 'RaiPolicy' update operation succeeded", + "schema": { + "$ref": "#/definitions/RaiPolicy" + } + }, + "201": { + "description": "Resource 'RaiPolicy' create operation succeeded", + "schema": { + "$ref": "#/definitions/RaiPolicy" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PutRaiPolicy": { + "$ref": "./examples/PutRaiPolicy.json" + } + } + }, + "delete": { + "operationId": "RaiPolicies_Delete", + "tags": [ + "RaiPolicies" + ], + "description": "Deletes the specified Content Filters associated with the Azure OpenAI account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiPolicyName", + "in": "path", + "description": "The name of the RaiPolicy associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "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 does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteRaiPolicy": { + "$ref": "./examples/DeleteRaiPolicy.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiToolLabels": { + "get": { + "operationId": "RaiToolLabels_List", + "tags": [ + "RaiToolLabels" + ], + "description": "Lists all RAI Tool Labels associated with the Azure OpenAI account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RaiToolLabelResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListRaiToolLabels": { + "$ref": "./examples/ListRaiToolLabels.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiToolLabels/{raiToolConnectionName}": { + "get": { + "operationId": "RaiToolLabels_Get", + "tags": [ + "RaiToolLabels" + ], + "description": "Gets the specified RAI Tool Label associated with the Azure OpenAI account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiToolConnectionName", + "in": "path", + "description": "The name of the Rai Tool Label", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RaiToolLabel" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetRaiToolLabel": { + "$ref": "./examples/GetRaiToolLabel.json" + } + } + }, + "put": { + "operationId": "RaiToolLabels_CreateOrUpdate", + "tags": [ + "RaiToolLabels" + ], + "description": "Creates the RAI Tool Label associated with the Azure OpenAI account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiToolConnectionName", + "in": "path", + "description": "The name of the Rai Tool Label", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiToolLabel", + "in": "body", + "description": "Properties describing the RAI Tool Label.", + "required": true, + "schema": { + "$ref": "#/definitions/RaiToolLabel" + } + } + ], + "responses": { + "200": { + "description": "Resource 'RaiToolLabel' update operation succeeded", + "schema": { + "$ref": "#/definitions/RaiToolLabel" + } + }, + "201": { + "description": "Resource 'RaiToolLabel' create operation succeeded", + "schema": { + "$ref": "#/definitions/RaiToolLabel" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PutRaiToolLabel": { + "$ref": "./examples/PutRaiToolLabel.json" + } + } + }, + "delete": { + "operationId": "RaiToolLabels_Delete", + "tags": [ + "RaiToolLabels" + ], + "description": "Deletes the specified RAI Tool Label associated with the Azure OpenAI account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiToolConnectionName", + "in": "path", + "description": "The name of the Rai Tool Label", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "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 does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteRaiToolLabel": { + "$ref": "./examples/DeleteRaiToolLabel.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raitopics": { + "get": { + "operationId": "RaiTopics_List", + "tags": [ + "RaiTopics" + ], + "description": "Gets the custom topics associated with the Azure OpenAI account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RaiTopicResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListRaiTopics": { + "$ref": "./examples/ListRaiTopics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raitopics/{raiTopicName}": { + "get": { + "operationId": "RaiTopics_Get", + "tags": [ + "RaiTopics" + ], + "description": "Gets the specified custom topic associated with the Azure OpenAI account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiTopicName", + "in": "path", + "description": "The name of the Rai Topic associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RaiTopic" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetRaiTopic": { + "$ref": "./examples/GetRaiTopic.json" + } + } + }, + "put": { + "operationId": "RaiTopics_CreateOrUpdate", + "tags": [ + "RaiTopics" + ], + "description": "Create the rai topic associated with the Azure OpenAI account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiTopicName", + "in": "path", + "description": "The name of the Rai Topic associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiTopic", + "in": "body", + "description": "Properties describing the rai topic.", + "required": true, + "schema": { + "$ref": "#/definitions/RaiTopic" + } + } + ], + "responses": { + "200": { + "description": "Resource 'RaiTopic' update operation succeeded", + "schema": { + "$ref": "#/definitions/RaiTopic" + } + }, + "201": { + "description": "Resource 'RaiTopic' create operation succeeded", + "schema": { + "$ref": "#/definitions/RaiTopic" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PutRaiTopic": { + "$ref": "./examples/PutRaiTopic.json" + } + } + }, + "delete": { + "operationId": "RaiTopics_Delete", + "tags": [ + "RaiTopics" + ], + "description": "Deletes the specified custom topic associated with the Azure OpenAI account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "raiTopicName", + "in": "path", + "description": "The name of the Rai Topic associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "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 does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteRaiTopic": { + "$ref": "./examples/DeleteRaiTopic.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/regenerateKey": { + "post": { + "operationId": "Accounts_RegenerateKey", + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Regenerates the specified account key for the specified Cognitive Services account.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "parameters", + "in": "body", + "description": "regenerate key parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiKeys" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Regenerate Keys": { + "$ref": "./examples/RegenerateKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/skus": { + "get": { + "operationId": "Accounts_ListSkus", + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "List available SKUs for the requested Cognitive Services account", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccountSkuListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List SKUs": { + "$ref": "./examples/ListSkus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/testRaiExternalSafetyProvider/{safetyProviderName}": { + "put": { + "operationId": "TestRaiExternalSafetyProvider_CreateOrUpdate", + "tags": [ + "TestRaiExternalSafetyProvider" + ], + "description": "Test the rai safety provider associated with the subscription.", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "safetyProviderName", + "in": "path", + "description": "The name of the Rai External Safety Provider associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "safetyProvider", + "in": "body", + "description": "Properties describing the rai external safety provider.", + "required": true, + "schema": { + "$ref": "#/definitions/RaiExternalSafetyProviderSchema" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RaiExternalSafetyProviderSchema" + } + }, + "201": { + "description": "Resource 'RaiExternalSafetyProviderSchema' create operation succeeded", + "schema": { + "$ref": "#/definitions/RaiExternalSafetyProviderSchema" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TestRaiExternalSafetyProvider": { + "$ref": "./examples/TestRaiExternalSafetyProvider.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/usages": { + "get": { + "operationId": "Accounts_ListUsages", + "tags": [ + "CognitiveServicesAccounts" + ], + "description": "Get usages for the requested Cognitive Services account", + "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": "accountName", + "in": "path", + "description": "The name of Cognitive Services account.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "$filter", + "in": "query", + "description": "An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Usages": { + "$ref": "./examples/GetUsages.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans": { + "get": { + "operationId": "CommitmentPlans_ListPlansByResourceGroup", + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Returns all the resources of a particular type belonging to a resource group", + "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" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CommitmentPlanListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Commitment Plans by Resource Group": { + "$ref": "./examples/ListSharedCommitmentPlansByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans/{commitmentPlanName}": { + "get": { + "operationId": "CommitmentPlans_GetPlan", + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Returns a Cognitive Services commitment plan specified by the parameters.", + "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": "commitmentPlanName", + "in": "path", + "description": "The name of the commitmentPlan associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Commitment Plan": { + "$ref": "./examples/GetSharedCommitmentPlan.json" + } + } + }, + "put": { + "operationId": "CommitmentPlans_CreateOrUpdatePlan", + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Create Cognitive Services commitment plan.", + "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": "commitmentPlanName", + "in": "path", + "description": "The name of the commitmentPlan associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "commitmentPlan", + "in": "body", + "description": "The parameters to provide for the created commitment plan.", + "required": true, + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CommitmentPlan' update operation succeeded", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "201": { + "description": "Resource 'CommitmentPlan' create operation succeeded", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create Commitment Plan": { + "$ref": "./examples/CreateSharedCommitmentPlan.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation", + "final-state-schema": "#/definitions/CommitmentPlan" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CommitmentPlans_UpdatePlan", + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Create Cognitive Services commitment plan.", + "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": "commitmentPlanName", + "in": "path", + "description": "The name of the commitmentPlan associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "commitmentPlan", + "in": "body", + "description": "The parameters to provide for the created commitment plan.", + "required": true, + "schema": { + "$ref": "#/definitions/PatchResourceTagsAndSku" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommitmentPlan" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create Commitment Plan": { + "$ref": "./examples/UpdateSharedCommitmentPlan.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/CommitmentPlan" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CommitmentPlans_DeletePlan", + "tags": [ + "CognitiveServicesCommitmentPlans" + ], + "description": "Deletes a Cognitive Services commitment plan from the resource group.", + "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": "commitmentPlanName", + "in": "path", + "description": "The name of the commitmentPlan associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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 does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Commitment Plan": { + "$ref": "./examples/DeleteSharedCommitmentPlan.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans/{commitmentPlanName}/accountAssociations": { + "get": { + "operationId": "CommitmentPlans_ListAssociations", + "tags": [ + "CommitmentPlans" + ], + "description": "Gets the associations of the Cognitive Services commitment plan.", + "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": "commitmentPlanName", + "in": "path", + "description": "The name of the commitmentPlan associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CommitmentPlanAccountAssociationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListCommitmentPlans": { + "$ref": "./examples/ListSharedCommitmentPlanAssociations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/commitmentPlans/{commitmentPlanName}/accountAssociations/{commitmentPlanAssociationName}": { + "get": { + "operationId": "CommitmentPlans_GetAssociation", + "tags": [ + "CommitmentPlans" + ], + "description": "Gets the association of the Cognitive Services commitment plan.", + "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": "commitmentPlanName", + "in": "path", + "description": "The name of the commitmentPlan associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "commitmentPlanAssociationName", + "in": "path", + "description": "The name of the commitment plan association with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommitmentPlanAccountAssociation" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetCommitmentPlan": { + "$ref": "./examples/GetSharedCommitmentPlanAssociation.json" + } + } + }, + "put": { + "operationId": "CommitmentPlans_CreateOrUpdateAssociation", + "tags": [ + "CommitmentPlans" + ], + "description": "Create or update the association of the Cognitive Services commitment plan.", + "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": "commitmentPlanName", + "in": "path", + "description": "The name of the commitmentPlan associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "commitmentPlanAssociationName", + "in": "path", + "description": "The name of the commitment plan association with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "association", + "in": "body", + "description": "The commitmentPlan properties.", + "required": true, + "schema": { + "$ref": "#/definitions/CommitmentPlanAccountAssociation" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CommitmentPlanAccountAssociation' update operation succeeded", + "schema": { + "$ref": "#/definitions/CommitmentPlanAccountAssociation" + } + }, + "201": { + "description": "Resource 'CommitmentPlanAccountAssociation' create operation succeeded", + "schema": { + "$ref": "#/definitions/CommitmentPlanAccountAssociation" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PutCommitmentPlan": { + "$ref": "./examples/CreateSharedCommitmentPlanAssociation.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation", + "final-state-schema": "#/definitions/CommitmentPlanAccountAssociation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CommitmentPlans_DeleteAssociation", + "tags": [ + "CommitmentPlans" + ], + "description": "Deletes the association of the Cognitive Services commitment plan.", + "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": "commitmentPlanName", + "in": "path", + "description": "The name of the commitmentPlan associated with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "name": "commitmentPlanAssociationName", + "in": "path", + "description": "The name of the commitment plan association with the Cognitive Services Account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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 does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteCommitmentPlan": { + "$ref": "./examples/DeleteSharedCommitmentPlanAssociation.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AADAuthTypeConnectionProperties": { + "type": "object", + "description": "This connection type covers the AAD auth for any applicable Azure service", + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "x-ms-discriminator-value": "AAD" + }, + "AbusePenalty": { + "type": "object", + "description": "The abuse penalty.", + "properties": { + "action": { + "$ref": "#/definitions/AbusePenaltyAction", + "description": "The action of AbusePenalty." + }, + "rateLimitPercentage": { + "type": "number", + "format": "float", + "description": "The percentage of rate limit." + }, + "expiration": { + "type": "string", + "format": "date-time", + "description": "The datetime of expiration of the AbusePenalty." + } + } + }, + "AbusePenaltyAction": { + "type": "string", + "description": "The action of AbusePenalty.", + "enum": [ + "Throttle", + "Block" + ], + "x-ms-enum": { + "name": "AbusePenaltyAction", + "modelAsString": true, + "values": [ + { + "name": "Throttle", + "value": "Throttle" + }, + { + "name": "Block", + "value": "Block" + } + ] + } + }, + "AccessKeyAuthTypeConnectionProperties": { + "type": "object", + "properties": { + "credentials": { + "$ref": "#/definitions/ConnectionAccessKey" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "x-ms-discriminator-value": "AccessKey" + }, + "Account": { + "type": "object", + "description": "Cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU.", + "properties": { + "properties": { + "$ref": "#/definitions/AccountProperties", + "description": "Properties of Cognitive Services account." + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "location": { + "type": "string", + "description": "The geo-location where the resource lives", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "etag": { + "type": "string", + "description": "Resource Etag.", + "readOnly": true + }, + "kind": { + "type": "string", + "description": "The kind (type) of cognitive service account." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The resource model definition representing SKU" + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "Identity for the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "AccountKeyAuthTypeConnectionProperties": { + "type": "object", + "description": "This connection type covers the account key connection for Azure storage", + "properties": { + "credentials": { + "$ref": "#/definitions/ConnectionAccountKey", + "description": "Account key object for connection credential." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "x-ms-discriminator-value": "AccountKey" + }, + "AccountListResult": { + "type": "object", + "description": "The list of cognitive services accounts operation response.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link used to get the next page of accounts." + }, + "value": { + "type": "array", + "description": "Gets the list of Cognitive Services accounts and their properties.", + "items": { + "$ref": "#/definitions/Account" + }, + "readOnly": true + } + } + }, + "AccountModel": { + "type": "object", + "description": "Cognitive Services account Model.", + "properties": { + "baseModel": { + "$ref": "#/definitions/DeploymentModel", + "description": "Properties of Cognitive Services account deployment model." + }, + "isDefaultVersion": { + "type": "boolean", + "description": "If the model is default version." + }, + "skus": { + "type": "array", + "description": "The list of Model Sku.", + "items": { + "$ref": "#/definitions/ModelSku" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "maxCapacity": { + "type": "integer", + "format": "int32", + "description": "The max capacity." + }, + "capabilities": { + "type": "object", + "description": "The capabilities.", + "additionalProperties": { + "type": "string" + } + }, + "finetuneCapabilities": { + "type": "object", + "description": "The capabilities for finetune models.", + "additionalProperties": { + "type": "string" + } + }, + "deprecation": { + "$ref": "#/definitions/ModelDeprecationInfo", + "description": "Cognitive Services account ModelDeprecationInfo." + }, + "replacementConfig": { + "$ref": "#/definitions/ReplacementConfig", + "description": "Configuration for model replacement." + }, + "modelCatalogAssetId": { + "type": "string", + "description": "Asset identifier for the model in the model catalog." + }, + "lifecycleStatus": { + "$ref": "#/definitions/ModelLifecycleStatus", + "description": "Model lifecycle status." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/DeploymentModel" + } + ] + }, + "AccountModelListResult": { + "type": "object", + "description": "The list of cognitive services accounts operation response.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link used to get the next page of Model." + }, + "value": { + "type": "array", + "description": "Gets the list of Cognitive Services accounts Model and their properties.", + "items": { + "$ref": "#/definitions/AccountModel" + }, + "x-ms-identifiers": [ + "name", + "format", + "version" + ] + } + } + }, + "AccountProperties": { + "type": "object", + "description": "Properties of Cognitive Services account.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Gets the status of the cognitive services account at the time the operation was called.", + "readOnly": true + }, + "endpoint": { + "type": "string", + "description": "Endpoint of the created account.", + "readOnly": true + }, + "internalId": { + "type": "string", + "description": "The internal identifier (deprecated, do not use this property).", + "readOnly": true + }, + "capabilities": { + "type": "array", + "description": "Gets the capabilities of the cognitive services account. Each item indicates the capability of a specific feature. The values are read-only and for reference only.", + "items": { + "$ref": "#/definitions/SkuCapability" + }, + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] + }, + "isMigrated": { + "type": "boolean", + "description": "If the resource is migrated from an existing key.", + "readOnly": true + }, + "migrationToken": { + "type": "string", + "description": "Resource migration token." + }, + "skuChangeInfo": { + "$ref": "#/definitions/SkuChangeInfo", + "description": "Sku change info of account.", + "readOnly": true + }, + "customSubDomainName": { + "type": "string", + "description": "Optional subdomain name used for token-based authentication." + }, + "networkAcls": { + "$ref": "#/definitions/NetworkRuleSet", + "description": "A collection of rules governing the accessibility from specific network locations." + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "The encryption properties for this resource." + }, + "userOwnedStorage": { + "type": "array", + "description": "The storage accounts for this resource.", + "items": { + "$ref": "#/definitions/UserOwnedStorage" + }, + "x-ms-identifiers": [ + "resourceId" + ] + }, + "amlWorkspace": { + "$ref": "#/definitions/UserOwnedAmlWorkspace", + "description": "The user owned AML account properties." + }, + "privateEndpointConnections": { + "type": "array", + "description": "The private endpoint connection associated with the Cognitive Services account.", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "publicNetworkAccess": { + "$ref": "#/definitions/PublicNetworkAccess", + "description": "Whether or not public endpoint access is allowed for this account." + }, + "apiProperties": { + "$ref": "#/definitions/ApiProperties", + "description": "The api properties for special APIs." + }, + "dateCreated": { + "type": "string", + "description": "Gets the date of cognitive services account creation.", + "readOnly": true + }, + "callRateLimit": { + "$ref": "#/definitions/CallRateLimit", + "description": "The call rate limit Cognitive Services account.", + "readOnly": true + }, + "dynamicThrottlingEnabled": { + "type": "boolean", + "description": "The flag to enable dynamic throttling." + }, + "storedCompletionsDisabled": { + "type": "boolean", + "description": "The flag to disable stored completions." + }, + "quotaLimit": { + "$ref": "#/definitions/QuotaLimit", + "readOnly": true + }, + "restrictOutboundNetworkAccess": { + "type": "boolean" + }, + "allowedFqdnList": { + "type": "array", + "items": { + "type": "string" + } + }, + "disableLocalAuth": { + "type": "boolean" + }, + "endpoints": { + "type": "object", + "description": "Dictionary of ", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "restore": { + "type": "boolean", + "x-ms-mutability": [ + "update", + "create" + ] + }, + "deletionDate": { + "type": "string", + "description": "The deletion date, only available for deleted account.", + "readOnly": true + }, + "scheduledPurgeDate": { + "type": "string", + "description": "The scheduled purge date, only available for deleted account.", + "readOnly": true + }, + "locations": { + "$ref": "#/definitions/MultiRegionSettings", + "description": "The multiregion settings of Cognitive Services account." + }, + "commitmentPlanAssociations": { + "type": "array", + "description": "The commitment plan associations of Cognitive Services account.", + "items": { + "$ref": "#/definitions/CommitmentPlanAssociation" + }, + "readOnly": true, + "x-ms-identifiers": [ + "commitmentPlanId" + ] + }, + "abusePenalty": { + "$ref": "#/definitions/AbusePenalty", + "description": "The abuse penalty.", + "readOnly": true + }, + "raiMonitorConfig": { + "$ref": "#/definitions/RaiMonitorConfig", + "description": "Cognitive Services Rai Monitor Config." + }, + "networkInjections": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInjection" + } + }, + "allowProjectManagement": { + "type": "boolean", + "description": "Specifies whether this resource support project management as child resources, used as containers for access management, data isolation and cost in AI Foundry." + }, + "defaultProject": { + "type": "string", + "description": "Specifies the project, by project name, that is targeted when data plane endpoints are called without a project parameter." + }, + "associatedProjects": { + "type": "array", + "description": "Specifies the projects, by project name, that are associated with this resource.", + "items": { + "type": "string" + } + } + } + }, + "AccountSku": { + "type": "object", + "description": "Cognitive Services resource type and SKU.", + "properties": { + "resourceType": { + "type": "string", + "description": "Resource Namespace and Type" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU of Cognitive Services account." + } + } + }, + "AccountSkuListResult": { + "type": "object", + "description": "The list of cognitive services accounts operation response.", + "properties": { + "value": { + "type": "array", + "description": "Gets the list of Cognitive Services accounts and their properties.", + "items": { + "$ref": "#/definitions/AccountSku" + }, + "x-ms-identifiers": [ + "sku/name", + "resourceType" + ] + } + } + }, + "ActionType": { + "type": "string", + "description": "Enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.", + "enum": [ + "Internal" + ], + "x-ms-enum": { + "name": "ActionType", + "modelAsString": true, + "values": [ + { + "name": "Internal", + "value": "Internal" + } + ] + } + }, + "AgentApplication": { + "type": "object", + "description": "Agent Application resource", + "properties": { + "properties": { + "$ref": "#/definitions/AgenticApplicationProperties", + "description": "[Required] Additional attributes of the entity." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "AgentApplicationResourceArmPaginatedResult": { + "type": "object", + "description": "A paginated list of Agent Application entities.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link to the next page of Agent Application objects. If null, there are no additional pages.", + "x-nullable": true + }, + "value": { + "type": "array", + "description": "An array of objects of type Agent Application.", + "items": { + "$ref": "#/definitions/AgentApplication" + } + } + } + }, + "AgentCard": { + "type": "object", + "description": "Represents a detailed description of an agent, including its name, functionality, hosting information, supported interaction modes, and available skills.", + "properties": { + "name": { + "type": "string", + "description": "Human-readable name for the Agent (e.g., 'Recipe Agent').", + "x-nullable": true + }, + "description": { + "type": "string", + "description": "Human-readable description of the Agent's function.", + "x-nullable": true + }, + "url": { + "type": "string", + "description": "URL address where the Agent is hosted.", + "x-nullable": true + }, + "provider": { + "$ref": "#/definitions/ProviderInfo", + "description": "Service provider information for the Agent.", + "x-nullable": true + }, + "version": { + "type": "string", + "description": "Version of the Agent (format defined by provider, e.g., '1.0.0').", + "x-nullable": true + }, + "documentationUrl": { + "type": "string", + "description": "URL for the Agent's documentation.", + "x-nullable": true + }, + "defaultInputModes": { + "type": "array", + "description": "Default interaction modes supported by the Agent across all skills.", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "defaultOutputModes": { + "type": "array", + "description": "Default output modes supported by the Agent across all skills.", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "skills": { + "type": "array", + "description": "Collection of capability units the Agent can perform.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/Skill" + } + } + } + }, + "AgentDeployment": { + "type": "object", + "description": "Agent Deployment resource", + "properties": { + "properties": { + "$ref": "#/definitions/AgentDeploymentProperties", + "description": "[Required] Additional attributes of the entity." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "AgentDeploymentProperties": { + "type": "object", + "description": "Type representing an agent deployment as a management construct.", + "properties": { + "displayName": { + "type": "string", + "description": "Gets or sets the display name of the deployment.", + "x-nullable": true + }, + "deploymentId": { + "type": "string", + "description": "Gets or sets the unique identifier of the deployment.", + "x-nullable": true + }, + "state": { + "$ref": "#/definitions/AgentDeploymentState", + "description": "Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).", + "x-nullable": true + }, + "protocols": { + "type": "array", + "description": "Gets or sets the supported protocol types and versions exposed by this deployment.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/AgentProtocolVersion" + } + }, + "agents": { + "type": "array", + "description": "Returns a flat list of agent:version deployed in this deployment.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/VersionedAgentReference" + } + }, + "deploymentType": { + "$ref": "#/definitions/AgentDeploymentType", + "description": "Gets or sets the type of deployment for the agent." + }, + "provisioningState": { + "$ref": "#/definitions/AgentDeploymentProvisioningState", + "description": "Gets or sets the provisioning state of the agent deployment.", + "readOnly": true + } + }, + "discriminator": "deploymentType", + "required": [ + "deploymentType" + ], + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ] + }, + "AgentDeploymentProvisioningState": { + "type": "string", + "description": "Provisioning state of an agentic deployment, as an Azure resource.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Updating", + "Deleting" + ], + "x-ms-enum": { + "name": "AgentDeploymentProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The deployment was successfully completed." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The deployment failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "The deployment was canceled." + }, + { + "name": "Creating", + "value": "Creating", + "description": "The deployment is being created." + }, + { + "name": "Updating", + "value": "Updating", + "description": "The deployment is being updated." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The deployment is being deleted." + } + ] + }, + "readOnly": true + }, + "AgentDeploymentResourceArmPaginatedResult": { + "type": "object", + "description": "A paginated list of Agent Deployment entities.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link to the next page of Agent Deployment objects. If null, there are no additional pages.", + "x-nullable": true + }, + "value": { + "type": "array", + "description": "An array of objects of type Agent Deployment.", + "items": { + "$ref": "#/definitions/AgentDeployment" + } + } + } + }, + "AgentDeploymentState": { + "type": "string", + "description": "Current operational state of the agentic functionality represented by this deployment.", + "enum": [ + "Starting", + "Running", + "Stopping", + "Stopped", + "Failed", + "Deleting", + "Deleted", + "Updating" + ], + "x-ms-enum": { + "name": "AgentDeploymentState", + "modelAsString": true, + "values": [ + { + "name": "Starting", + "value": "Starting", + "description": "The deployment is starting." + }, + { + "name": "Running", + "value": "Running", + "description": "The deployment started/is operational." + }, + { + "name": "Stopping", + "value": "Stopping", + "description": "The deployment is being stopped." + }, + { + "name": "Stopped", + "value": "Stopped", + "description": "The deployment was stopped." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The deployment failed." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The deployment is being deleted." + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "The deployment was deleted." + }, + { + "name": "Updating", + "value": "Updating", + "description": "The deployment is being updated." + } + ] + } + }, + "AgentDeploymentType": { + "type": "string", + "description": "Specifies the type of deployment for an agent, indicating how the underlying compute and network infrastructure is managed.", + "enum": [ + "Managed", + "Hosted", + "Custom" + ], + "x-ms-enum": { + "name": "AgentDeploymentType", + "modelAsString": true, + "values": [ + { + "name": "Managed", + "value": "Managed", + "description": "The underlying infra is managed by the platform in the deployer's subscription" + }, + { + "name": "Hosted", + "value": "Hosted", + "description": "The underlying infra is owned by the platform" + }, + { + "name": "Custom", + "value": "Custom", + "description": "The underlying infra is provisioned by the deployer (BYO)" + } + ] + } + }, + "AgentProtocol": { + "type": "string", + "description": "Protocol used by the agent/exposed by a deployment.", + "enum": [ + "Agent", + "A2A", + "Responses" + ], + "x-ms-enum": { + "name": "AgentProtocol", + "modelAsString": true, + "values": [ + { + "name": "Agent", + "value": "Agent", + "description": "Agent protocol (aka Active)" + }, + { + "name": "A2A", + "value": "A2A", + "description": "Agent2Agent standard" + }, + { + "name": "Responses", + "value": "Responses", + "description": "OpenAI-compatible" + } + ] + } + }, + "AgentProtocolVersion": { + "type": "object", + "description": "Type modeling the protocol and version used by an agent/exposed by a deployment.", + "properties": { + "protocol": { + "$ref": "#/definitions/AgentProtocol", + "description": "The protocol used by the agent/exposed by a deployment." + }, + "version": { + "type": "string", + "description": "The version of the protocol.", + "x-nullable": true + } + } + }, + "AgentReference": { + "type": "object", + "description": "Agent Reference resource", + "properties": { + "properties": { + "$ref": "#/definitions/AgentReferenceProperties", + "description": "[Required] Additional attributes of the entity." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "AgentReferenceProperties": { + "type": "object", + "description": "Type modeling a reference to a version of an agent definition.", + "properties": { + "agentId": { + "type": "string", + "description": "Gets the agent's unique identifier within the organization (subscription).", + "x-nullable": true + }, + "agentName": { + "type": "string", + "description": "Gets the agent's name (unique within the project/app).", + "x-nullable": true + } + } + }, + "AgentReferenceResourceArmPaginatedResult": { + "type": "object", + "description": "A paginated list of Agent Reference entities.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link to the next page of Agent Reference objects. If null, there are no additional pages.", + "x-nullable": true + }, + "value": { + "type": "array", + "description": "An array of objects of type Agent Reference.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/AgentReference" + } + } + } + }, + "AgenticApplicationProperties": { + "type": "object", + "description": "Resource type representing an agentic application as a management construct.", + "properties": { + "displayName": { + "type": "string", + "description": "The display name of the application.", + "x-nullable": true + }, + "baseUrl": { + "type": "string", + "description": "The application's dedicated invocation endpoint.", + "x-nullable": true + }, + "agents": { + "type": "array", + "description": "The list of agent definitions comprising this application, returned as references to the objects under the parent project; use this to obtain a flat list of all agent-version pairs represented by this application.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/AgentReferenceProperties" + } + }, + "agentIdentityBlueprint": { + "$ref": "#/definitions/AssignedIdentity", + "description": "The EntraId Agentic Blueprint of the application.", + "x-nullable": true + }, + "defaultInstanceIdentity": { + "$ref": "#/definitions/AssignedIdentity", + "description": "The (default) agent instance identity of the application.", + "x-nullable": true + }, + "authorizationPolicy": { + "$ref": "#/definitions/ApplicationAuthorizationPolicy", + "description": "Gets or sets the authorization policy associated with this agentic application instance.", + "x-nullable": true + }, + "trafficRoutingPolicy": { + "$ref": "#/definitions/ApplicationTrafficRoutingPolicy", + "description": "Gets or sets the traffic routing policy for the application's deployments.", + "x-nullable": true + }, + "provisioningState": { + "$ref": "#/definitions/AgenticApplicationProvisioningState", + "description": "Provisioning state of the application.", + "readOnly": true + }, + "isEnabled": { + "type": "boolean", + "description": "Enabledstate of the application.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ] + }, + "AgenticApplicationProvisioningState": { + "type": "string", + "description": "Provisioning state of an agentic application.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Updating", + "Deleting" + ], + "x-ms-enum": { + "name": "AgenticApplicationProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The application was successfully provisioned." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The application provisioning failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "The application provisioning was canceled." + }, + { + "name": "Creating", + "value": "Creating", + "description": "The application is being created." + }, + { + "name": "Updating", + "value": "Updating", + "description": "The application is being updated." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The application is being deleted." + } + ] + }, + "readOnly": true + }, + "ApiKeyAuthConnectionProperties": { + "type": "object", + "description": "This connection type covers the generic ApiKey auth connection categories, for examples:\nAzureOpenAI:\nCategory:= AzureOpenAI\nAuthType:= ApiKey (as type discriminator)\nCredentials:= {ApiKey} as .ApiKey\nTarget:= {ApiBase}\n\nCognitiveService:\nCategory:= CognitiveService\nAuthType:= ApiKey (as type discriminator)\nCredentials:= {SubscriptionKey} as ApiKey\nTarget:= ServiceRegion={serviceRegion}\n\nCognitiveSearch:\nCategory:= CognitiveSearch\nAuthType:= ApiKey (as type discriminator)\nCredentials:= {Key} as ApiKey\nTarget:= {Endpoint}\n\nUse Metadata property bag for ApiType, ApiVersion, Kind and other metadata fields", + "properties": { + "credentials": { + "$ref": "#/definitions/ConnectionApiKey", + "description": "Api key object for connection credential." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "x-ms-discriminator-value": "ApiKey" + }, + "ApiKeys": { + "type": "object", + "description": "The access keys for the cognitive services account.", + "properties": { + "key1": { + "type": "string", + "description": "Gets the value of key 1." + }, + "key2": { + "type": "string", + "description": "Gets the value of key 2." + } + } + }, + "ApiProperties": { + "type": "object", + "description": "The api properties for special APIs.", + "properties": { + "qnaRuntimeEndpoint": { + "type": "string", + "description": "(QnAMaker Only) The runtime endpoint of QnAMaker." + }, + "qnaAzureSearchEndpointKey": { + "type": "string", + "description": "(QnAMaker Only) The Azure Search endpoint key of QnAMaker." + }, + "qnaAzureSearchEndpointId": { + "type": "string", + "description": "(QnAMaker Only) The Azure Search endpoint id of QnAMaker." + }, + "statisticsEnabled": { + "type": "boolean", + "description": "(Bing Search Only) The flag to enable statistics of Bing Search." + }, + "eventHubConnectionString": { + "type": "string", + "description": "(Personalization Only) The flag to enable statistics of Bing Search.", + "maxLength": 1000, + "pattern": "^( *)Endpoint=sb://(.*);( *)SharedAccessKeyName=(.*);( *)SharedAccessKey=(.*)$" + }, + "storageAccountConnectionString": { + "type": "string", + "description": "(Personalization Only) The storage account connection string.", + "maxLength": 1000, + "pattern": "^(( *)DefaultEndpointsProtocol=(http|https)( *);( *))?AccountName=(.*)AccountKey=(.*)EndpointSuffix=(.*)$" + }, + "aadClientId": { + "type": "string", + "description": "(Metrics Advisor Only) The Azure AD Client Id (Application Id).", + "maxLength": 500 + }, + "aadTenantId": { + "type": "string", + "description": "(Metrics Advisor Only) The Azure AD Tenant Id.", + "maxLength": 500 + }, + "superUser": { + "type": "string", + "description": "(Metrics Advisor Only) The super user of Metrics Advisor.", + "maxLength": 500 + }, + "websiteName": { + "type": "string", + "description": "(Metrics Advisor Only) The website name of Metrics Advisor.", + "maxLength": 500 + } + }, + "additionalProperties": {} + }, + "ApplicationAuthorizationPolicy": { + "type": "object", + "description": "Represents a policy for authorizing applications based on specified authentication and authorization schemes.", + "properties": { + "type": { + "$ref": "#/definitions/BuiltInAuthorizationScheme", + "description": "Authorization scheme type." + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "ApplicationTrafficRoutingPolicy": { + "type": "object", + "description": "Type representing an application traffic policy as a property of an agentic application.", + "properties": { + "protocol": { + "$ref": "#/definitions/TrafficRoutingProtocol", + "description": "Methodology used to route traffic to the application's deployments." + }, + "rules": { + "type": "array", + "description": "Gets or sets the collection of traffic routing rules.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/TrafficRoutingRule" + } + } + } + }, + "AssignedIdentity": { + "type": "object", + "description": "Type representing an identity assignment", + "properties": { + "kind": { + "$ref": "#/definitions/IdentityKind", + "description": "Specifies the kind of Entra identity described by this object." + }, + "type": { + "$ref": "#/definitions/IdentityManagementType", + "description": "Enumeration of identity types, from the perspective of management." + }, + "clientId": { + "type": "string", + "description": "The client ID of the identity." + }, + "principalId": { + "type": "string", + "description": "The principal ID of the identity." + }, + "tenantId": { + "type": "string", + "description": "The tenant ID of the identity." + }, + "subject": { + "type": "string", + "description": "The subject of this identity assignment.", + "x-nullable": true + }, + "provisioningState": { + "$ref": "#/definitions/IdentityProvisioningState", + "description": "Represents the provisioning state of an identity resource.", + "readOnly": true + } + }, + "required": [ + "kind", + "type", + "clientId", + "principalId", + "tenantId" + ] + }, + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" + }, + "BillingMeterInfo": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "meterId": { + "type": "string" + }, + "unit": { + "type": "string" + } + } + }, + "BuiltInAuthorizationScheme": { + "type": "string", + "description": "Authorization scheme type.", + "enum": [ + "Default", + "OrganizationScope", + "Channels", + "Custom" + ], + "x-ms-enum": { + "name": "BuiltInAuthorizationScheme", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Standard AzureML RBAC" + }, + { + "name": "OrganizationScope", + "value": "OrganizationScope", + "description": "Claim-based, requires membership in the tenant" + }, + { + "name": "Channels", + "value": "Channels", + "description": "Channels-specific (AzureBotService) authorization" + }, + { + "name": "Custom", + "value": "Custom", + "description": "Custom scheme defined by the application author" + } + ] + } + }, + "ByPassSelection": { + "type": "string", + "description": "Setting for trusted services.", + "enum": [ + "None", + "AzureServices" + ], + "x-ms-enum": { + "name": "ByPassSelection", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None" + }, + { + "name": "AzureServices", + "value": "AzureServices" + } + ] + } + }, + "CalculateModelCapacityParameter": { + "type": "object", + "description": "Calculate Model Capacity parameter.", + "properties": { + "model": { + "$ref": "#/definitions/DeploymentModel", + "description": "Properties of Cognitive Services account deployment model." + }, + "skuName": { + "type": "string", + "description": "The name of SKU." + }, + "workloads": { + "type": "array", + "description": "List of Model Capacity Calculator Workload.", + "items": { + "$ref": "#/definitions/ModelCapacityCalculatorWorkload" + }, + "x-ms-identifiers": [] + } + } + }, + "CalculateModelCapacityResult": { + "type": "object", + "description": "Calculate Model Capacity result.", + "properties": { + "model": { + "$ref": "#/definitions/DeploymentModel", + "description": "Properties of Cognitive Services account deployment model." + }, + "skuName": { + "type": "string" + }, + "estimatedCapacity": { + "$ref": "#/definitions/CalculateModelCapacityResultEstimatedCapacity", + "description": "Model Estimated Capacity." + } + } + }, + "CalculateModelCapacityResultEstimatedCapacity": { + "type": "object", + "description": "Model Estimated Capacity.", + "properties": { + "value": { + "type": "integer", + "format": "int32" + }, + "deployableValue": { + "type": "integer", + "format": "int32" + } + } + }, + "CallRateLimit": { + "type": "object", + "description": "The call rate limit Cognitive Services account.", + "properties": { + "count": { + "type": "number", + "format": "float", + "description": "The count value of Call Rate Limit." + }, + "renewalPeriod": { + "type": "number", + "format": "float", + "description": "The renewal period in seconds of Call Rate Limit." + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/ThrottlingRule" + }, + "x-ms-identifiers": [ + "key" + ] + } + } + }, + "CapabilityHost": { + "type": "object", + "description": "Azure Resource Manager resource envelope.", + "properties": { + "properties": { + "$ref": "#/definitions/CapabilityHostProperties", + "description": "[Required] Additional attributes of the entity." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "CapabilityHostKind": { + "type": "string", + "enum": [ + "Agents" + ], + "x-ms-enum": { + "name": "CapabilityHostKind", + "modelAsString": true, + "values": [ + { + "name": "Agents", + "value": "Agents" + } + ] + } + }, + "CapabilityHostProperties": { + "type": "object", + "properties": { + "aiServicesConnections": { + "type": "array", + "description": "List of AI services connections.", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "capabilityHostKind": { + "$ref": "#/definitions/CapabilityHostKind", + "description": "Kind of this capability host." + }, + "customerSubnet": { + "type": "string", + "description": "Customer subnet info to help set up this capability host.", + "x-nullable": true + }, + "provisioningState": { + "$ref": "#/definitions/CapabilityHostProvisioningState", + "description": "Provisioning state for the CapabilityHost.", + "readOnly": true + }, + "storageConnections": { + "type": "array", + "description": "List of connection names from those available in the account or project to be used as a storage resource.", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "threadStorageConnections": { + "type": "array", + "description": "List of connection names from those available in the account or project to be used for Thread storage.", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "vectorStoreConnections": { + "type": "array", + "description": "List of connection names from those available in the account or project to be used for vector database (e.g. CosmosDB).", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "enablePublicHostingEnvironment": { + "type": "boolean", + "description": "Whether public hosting environment is enabled for the capability host" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ] + }, + "CapabilityHostProvisioningState": { + "type": "string", + "description": "Provisioning state of capability host.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Updating", + "Deleting" + ], + "x-ms-enum": { + "name": "CapabilityHostProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded" + }, + { + "name": "Failed", + "value": "Failed" + }, + { + "name": "Canceled", + "value": "Canceled" + }, + { + "name": "Creating", + "value": "Creating" + }, + { + "name": "Updating", + "value": "Updating" + }, + { + "name": "Deleting", + "value": "Deleting" + } + ] + }, + "readOnly": true + }, + "CapabilityHostResourceArmPaginatedResult": { + "type": "object", + "description": "A paginated list of Capability Host entities.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link to the next page of Capability Host objects. If null, there are no additional pages.", + "x-nullable": true + }, + "value": { + "type": "array", + "description": "An array of objects of type Capability Host.", + "items": { + "$ref": "#/definitions/CapabilityHost" + } + } + } + }, + "CapacityConfig": { + "type": "object", + "description": "The capacity configuration.", + "properties": { + "minimum": { + "type": "integer", + "format": "int32", + "description": "The minimum capacity." + }, + "maximum": { + "type": "integer", + "format": "int32", + "description": "The maximum capacity." + }, + "step": { + "type": "integer", + "format": "int32", + "description": "The minimal incremental between allowed values for capacity." + }, + "default": { + "type": "integer", + "format": "int32", + "description": "The default capacity." + }, + "allowedValues": { + "type": "array", + "description": "The array of allowed values for capacity.", + "items": { + "type": "integer", + "format": "int32" + } + } + } + }, + "ChannelsBuiltInAuthorizationPolicy": { + "type": "object", + "description": "Represents a built-in authorization policy specific to Azure Bot Service/Channels authentication.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationAuthorizationPolicy" + } + ], + "x-ms-discriminator-value": "Channels" + }, + "CheckDomainAvailabilityParameter": { + "type": "object", + "description": "Check Domain availability parameter.", + "properties": { + "subdomainName": { + "type": "string", + "description": "The subdomain name to use." + }, + "type": { + "type": "string", + "description": "The Type of the resource." + }, + "kind": { + "type": "string", + "description": "The kind (type) of cognitive service account." + } + }, + "required": [ + "subdomainName", + "type" + ] + }, + "CheckSkuAvailabilityParameter": { + "type": "object", + "description": "Check SKU availability parameter.", + "properties": { + "skus": { + "type": "array", + "description": "The SKU of the resource.", + "items": { + "type": "string" + } + }, + "kind": { + "type": "string", + "description": "The kind (type) of cognitive service account." + }, + "type": { + "type": "string", + "description": "The Type of the resource." + } + }, + "required": [ + "skus", + "kind", + "type" + ] + }, + "CommitmentCost": { + "type": "object", + "description": "Cognitive Services account commitment cost.", + "properties": { + "commitmentMeterId": { + "type": "string", + "description": "Commitment meter Id." + }, + "overageMeterId": { + "type": "string", + "description": "Overage meter Id." + } + } + }, + "CommitmentPeriod": { + "type": "object", + "description": "Cognitive Services account commitment period.", + "properties": { + "tier": { + "type": "string", + "description": "Commitment period commitment tier." + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Commitment period commitment count." + }, + "quota": { + "$ref": "#/definitions/CommitmentQuota", + "description": "Cognitive Services account commitment quota.", + "readOnly": true + }, + "startDate": { + "type": "string", + "description": "Commitment period start date.", + "readOnly": true + }, + "endDate": { + "type": "string", + "description": "Commitment period end date.", + "readOnly": true + } + } + }, + "CommitmentPlan": { + "type": "object", + "description": "Cognitive Services account commitment plan.", + "properties": { + "properties": { + "$ref": "#/definitions/CommitmentPlanProperties", + "description": "Properties of Cognitive Services account commitment plan." + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "location": { + "type": "string", + "description": "The geo-location where the resource lives", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "etag": { + "type": "string", + "description": "Resource Etag.", + "readOnly": true + }, + "kind": { + "type": "string", + "description": "The kind (type) of cognitive service account." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The resource model definition representing SKU" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "CommitmentPlanAccountAssociation": { + "type": "object", + "description": "The commitment plan association.", + "properties": { + "properties": { + "$ref": "#/definitions/CommitmentPlanAccountAssociationProperties", + "description": "Properties of Cognitive Services account commitment plan association.", + "x-ms-client-flatten": true + }, + "etag": { + "type": "string", + "description": "Resource Etag.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "CommitmentPlanAccountAssociationListResult": { + "type": "object", + "description": "The list of cognitive services Commitment Plan Account Association operation response.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link used to get the next page of Commitment Plan Account Association." + }, + "value": { + "type": "array", + "description": "Gets the list of Cognitive Services Commitment Plan Account Association and their properties.", + "items": { + "$ref": "#/definitions/CommitmentPlanAccountAssociation" + }, + "readOnly": true, + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "CommitmentPlanAccountAssociationProperties": { + "type": "object", + "description": "The commitment plan account association properties.", + "properties": { + "accountId": { + "type": "string", + "description": "The Azure resource id of the account." + } + } + }, + "CommitmentPlanAssociation": { + "type": "object", + "description": "The commitment plan association.", + "properties": { + "commitmentPlanId": { + "type": "string", + "description": "The Azure resource id of the commitment plan." + }, + "commitmentPlanLocation": { + "type": "string", + "description": "The location of of the commitment plan." + } + } + }, + "CommitmentPlanListResult": { + "type": "object", + "description": "The list of cognitive services accounts operation response.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link used to get the next page of CommitmentPlan." + }, + "value": { + "type": "array", + "description": "Gets the list of Cognitive Services accounts CommitmentPlan and their properties.", + "items": { + "$ref": "#/definitions/CommitmentPlan" + }, + "readOnly": true + } + } + }, + "CommitmentPlanProperties": { + "type": "object", + "description": "Properties of Cognitive Services account commitment plan.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/CommitmentPlanProvisioningState", + "description": "Gets the status of the resource at the time the operation was called.", + "readOnly": true + }, + "commitmentPlanGuid": { + "type": "string", + "description": "Commitment plan guid." + }, + "hostingModel": { + "$ref": "#/definitions/HostingModel", + "description": "Account hosting model." + }, + "planType": { + "type": "string", + "description": "Commitment plan type." + }, + "current": { + "$ref": "#/definitions/CommitmentPeriod", + "description": "Cognitive Services account commitment period." + }, + "autoRenew": { + "type": "boolean", + "description": "AutoRenew commitment plan." + }, + "next": { + "$ref": "#/definitions/CommitmentPeriod", + "description": "Cognitive Services account commitment period." + }, + "last": { + "$ref": "#/definitions/CommitmentPeriod", + "description": "Cognitive Services account commitment period.", + "readOnly": true + }, + "provisioningIssues": { + "type": "array", + "description": "The list of ProvisioningIssue.", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "CommitmentPlanProvisioningState": { + "type": "string", + "description": "Gets the status of the resource at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Deleting", + "Moving", + "Failed", + "Succeeded", + "Canceled" + ], + "x-ms-enum": { + "name": "CommitmentPlanProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Accepted", + "value": "Accepted" + }, + { + "name": "Creating", + "value": "Creating" + }, + { + "name": "Deleting", + "value": "Deleting" + }, + { + "name": "Moving", + "value": "Moving" + }, + { + "name": "Failed", + "value": "Failed" + }, + { + "name": "Succeeded", + "value": "Succeeded" + }, + { + "name": "Canceled", + "value": "Canceled" + } + ] + }, + "readOnly": true + }, + "CommitmentQuota": { + "type": "object", + "description": "Cognitive Services account commitment quota.", + "properties": { + "quantity": { + "type": "integer", + "format": "int64", + "description": "Commitment quota quantity." + }, + "unit": { + "type": "string", + "description": "Commitment quota unit." + } + } + }, + "CommitmentTier": { + "type": "object", + "description": "Cognitive Services account commitment tier.", + "properties": { + "kind": { + "type": "string", + "description": "The kind (type) of cognitive service account." + }, + "skuName": { + "type": "string", + "description": "The name of the SKU. Ex - P3. It is typically a letter+number code" + }, + "hostingModel": { + "$ref": "#/definitions/HostingModel", + "description": "Account hosting model." + }, + "planType": { + "type": "string", + "description": "Commitment plan type." + }, + "tier": { + "type": "string", + "description": "Commitment period commitment tier." + }, + "maxCount": { + "type": "integer", + "format": "int32", + "description": "Commitment period commitment max count." + }, + "quota": { + "$ref": "#/definitions/CommitmentQuota", + "description": "Cognitive Services account commitment quota." + }, + "cost": { + "$ref": "#/definitions/CommitmentCost", + "description": "Cognitive Services account commitment cost." + } + } + }, + "CommitmentTierListResult": { + "type": "object", + "description": "The list of cognitive services accounts operation response.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link used to get the next page of CommitmentTier." + }, + "value": { + "type": "array", + "description": "Gets the list of Cognitive Services accounts CommitmentTier and their properties.", + "items": { + "$ref": "#/definitions/CommitmentTier" + }, + "readOnly": true, + "x-ms-identifiers": [ + "kind", + "tier", + "skuName", + "hostingModel", + "planType" + ] + } + } + }, + "ConnectionAccessKey": { + "type": "object", + "properties": { + "accessKeyId": { + "type": "string" + }, + "secretAccessKey": { + "type": "string", + "format": "password", + "x-ms-secret": true + } + } + }, + "ConnectionAccountKey": { + "type": "object", + "description": "Account key object for connection credential.", + "properties": { + "key": { + "type": "string", + "format": "password", + "x-ms-secret": true + } + } + }, + "ConnectionApiKey": { + "type": "object", + "description": "Api key object for connection credential.", + "properties": { + "key": { + "type": "string", + "format": "password", + "x-ms-secret": true + } + } + }, + "ConnectionAuthType": { + "type": "string", + "description": "Authentication type of the connection target", + "enum": [ + "PAT", + "ManagedIdentity", + "UsernamePassword", + "None", + "SAS", + "AccountKey", + "ServicePrincipal", + "AccessKey", + "ApiKey", + "CustomKeys", + "OAuth2", + "AAD", + "DelegatedSAS", + "ProjectManagedIdentity", + "AccountManagedIdentity", + "UserEntraToken", + "AgentUserImpersonation", + "AgenticIdentityToken", + "AgenticUser" + ], + "x-ms-enum": { + "name": "ConnectionAuthType", + "modelAsString": true, + "values": [ + { + "name": "PAT", + "value": "PAT" + }, + { + "name": "ManagedIdentity", + "value": "ManagedIdentity" + }, + { + "name": "UsernamePassword", + "value": "UsernamePassword" + }, + { + "name": "None", + "value": "None" + }, + { + "name": "SAS", + "value": "SAS" + }, + { + "name": "AccountKey", + "value": "AccountKey" + }, + { + "name": "ServicePrincipal", + "value": "ServicePrincipal" + }, + { + "name": "AccessKey", + "value": "AccessKey" + }, + { + "name": "ApiKey", + "value": "ApiKey" + }, + { + "name": "CustomKeys", + "value": "CustomKeys" + }, + { + "name": "OAuth2", + "value": "OAuth2" + }, + { + "name": "AAD", + "value": "AAD" + }, + { + "name": "DelegatedSAS", + "value": "DelegatedSAS" + }, + { + "name": "ProjectManagedIdentity", + "value": "ProjectManagedIdentity" + }, + { + "name": "AccountManagedIdentity", + "value": "AccountManagedIdentity" + }, + { + "name": "UserEntraToken", + "value": "UserEntraToken" + }, + { + "name": "AgentUserImpersonation", + "value": "AgentUserImpersonation" + }, + { + "name": "AgenticIdentityToken", + "value": "AgenticIdentityToken" + }, + { + "name": "AgenticUser", + "value": "AgenticUser" + } + ] + } + }, + "ConnectionCategory": { + "type": "string", + "description": "Category of the connection", + "enum": [ + "PythonFeed", + "ContainerRegistry", + "Git", + "S3", + "Snowflake", + "AzureKeyVault", + "AzureSqlDb", + "AzureSynapseAnalytics", + "AzureMySqlDb", + "AzurePostgresDb", + "ADLSGen2", + "AzureContainerAppEnvironment", + "Redis", + "ApiKey", + "AzureOpenAI", + "AIServices", + "CognitiveSearch", + "CognitiveService", + "CustomKeys", + "AzureBlob", + "AzureStorageAccount", + "AzureOneLake", + "CosmosDb", + "CosmosDbMongoDbApi", + "AzureDataExplorer", + "AzureMariaDb", + "AzureDatabricksDeltaLake", + "AzureSqlMi", + "AzureTableStorage", + "AmazonRdsForOracle", + "AmazonRdsForSqlServer", + "AmazonRedshift", + "Db2", + "Drill", + "GoogleBigQuery", + "Greenplum", + "Hbase", + "Hive", + "Impala", + "Informix", + "MariaDb", + "MicrosoftAccess", + "MySql", + "Netezza", + "Oracle", + "Phoenix", + "PostgreSql", + "Presto", + "SapOpenHub", + "SapBw", + "SapHana", + "SapTable", + "Spark", + "SqlServer", + "Sybase", + "Teradata", + "Vertica", + "Pinecone", + "Databricks", + "Cassandra", + "Couchbase", + "MongoDbV2", + "MongoDbAtlas", + "AmazonS3Compatible", + "FileServer", + "FtpServer", + "GoogleCloudStorage", + "Hdfs", + "OracleCloudStorage", + "Sftp", + "GenericHttp", + "ODataRest", + "Odbc", + "GenericRest", + "RemoteTool", + "AmazonMws", + "Concur", + "Dynamics", + "DynamicsAx", + "DynamicsCrm", + "GoogleAdWords", + "Hubspot", + "Jira", + "Magento", + "Marketo", + "Office365", + "Eloqua", + "Responsys", + "OracleServiceCloud", + "PayPal", + "QuickBooks", + "Salesforce", + "SalesforceServiceCloud", + "SalesforceMarketingCloud", + "SapCloudForCustomer", + "SapEcc", + "ServiceNow", + "SharePointOnlineList", + "Shopify", + "Square", + "WebTable", + "Xero", + "Zoho", + "GenericContainerRegistry", + "Elasticsearch", + "AppInsights", + "AppConfig", + "OpenAI", + "Serp", + "BingLLMSearch", + "Serverless", + "ManagedOnlineEndpoint", + "ApiManagement", + "ModelGateway", + "GroundingWithBingSearch", + "GroundingWithCustomSearch", + "Sharepoint", + "MicrosoftFabric", + "PowerPlatformEnvironment", + "RemoteA2A" + ], + "x-ms-enum": { + "name": "ConnectionCategory", + "modelAsString": true, + "values": [ + { + "name": "PythonFeed", + "value": "PythonFeed" + }, + { + "name": "ContainerRegistry", + "value": "ContainerRegistry" + }, + { + "name": "Git", + "value": "Git" + }, + { + "name": "S3", + "value": "S3" + }, + { + "name": "Snowflake", + "value": "Snowflake" + }, + { + "name": "AzureKeyVault", + "value": "AzureKeyVault" + }, + { + "name": "AzureSqlDb", + "value": "AzureSqlDb" + }, + { + "name": "AzureSynapseAnalytics", + "value": "AzureSynapseAnalytics" + }, + { + "name": "AzureMySqlDb", + "value": "AzureMySqlDb" + }, + { + "name": "AzurePostgresDb", + "value": "AzurePostgresDb" + }, + { + "name": "ADLSGen2", + "value": "ADLSGen2" + }, + { + "name": "AzureContainerAppEnvironment", + "value": "AzureContainerAppEnvironment" + }, + { + "name": "Redis", + "value": "Redis" + }, + { + "name": "ApiKey", + "value": "ApiKey" + }, + { + "name": "AzureOpenAI", + "value": "AzureOpenAI" + }, + { + "name": "AIServices", + "value": "AIServices" + }, + { + "name": "CognitiveSearch", + "value": "CognitiveSearch" + }, + { + "name": "CognitiveService", + "value": "CognitiveService" + }, + { + "name": "CustomKeys", + "value": "CustomKeys" + }, + { + "name": "AzureBlob", + "value": "AzureBlob" + }, + { + "name": "AzureStorageAccount", + "value": "AzureStorageAccount" + }, + { + "name": "AzureOneLake", + "value": "AzureOneLake" + }, + { + "name": "CosmosDb", + "value": "CosmosDb" + }, + { + "name": "CosmosDbMongoDbApi", + "value": "CosmosDbMongoDbApi" + }, + { + "name": "AzureDataExplorer", + "value": "AzureDataExplorer" + }, + { + "name": "AzureMariaDb", + "value": "AzureMariaDb" + }, + { + "name": "AzureDatabricksDeltaLake", + "value": "AzureDatabricksDeltaLake" + }, + { + "name": "AzureSqlMi", + "value": "AzureSqlMi" + }, + { + "name": "AzureTableStorage", + "value": "AzureTableStorage" + }, + { + "name": "AmazonRdsForOracle", + "value": "AmazonRdsForOracle" + }, + { + "name": "AmazonRdsForSqlServer", + "value": "AmazonRdsForSqlServer" + }, + { + "name": "AmazonRedshift", + "value": "AmazonRedshift" + }, + { + "name": "Db2", + "value": "Db2" + }, + { + "name": "Drill", + "value": "Drill" + }, + { + "name": "GoogleBigQuery", + "value": "GoogleBigQuery" + }, + { + "name": "Greenplum", + "value": "Greenplum" + }, + { + "name": "Hbase", + "value": "Hbase" + }, + { + "name": "Hive", + "value": "Hive" + }, + { + "name": "Impala", + "value": "Impala" + }, + { + "name": "Informix", + "value": "Informix" + }, + { + "name": "MariaDb", + "value": "MariaDb" + }, + { + "name": "MicrosoftAccess", + "value": "MicrosoftAccess" + }, + { + "name": "MySql", + "value": "MySql" + }, + { + "name": "Netezza", + "value": "Netezza" + }, + { + "name": "Oracle", + "value": "Oracle" + }, + { + "name": "Phoenix", + "value": "Phoenix" + }, + { + "name": "PostgreSql", + "value": "PostgreSql" + }, + { + "name": "Presto", + "value": "Presto" + }, + { + "name": "SapOpenHub", + "value": "SapOpenHub" + }, + { + "name": "SapBw", + "value": "SapBw" + }, + { + "name": "SapHana", + "value": "SapHana" + }, + { + "name": "SapTable", + "value": "SapTable" + }, + { + "name": "Spark", + "value": "Spark" + }, + { + "name": "SqlServer", + "value": "SqlServer" + }, + { + "name": "Sybase", + "value": "Sybase" + }, + { + "name": "Teradata", + "value": "Teradata" + }, + { + "name": "Vertica", + "value": "Vertica" + }, + { + "name": "Pinecone", + "value": "Pinecone" + }, + { + "name": "Databricks", + "value": "Databricks" + }, + { + "name": "Cassandra", + "value": "Cassandra" + }, + { + "name": "Couchbase", + "value": "Couchbase" + }, + { + "name": "MongoDbV2", + "value": "MongoDbV2" + }, + { + "name": "MongoDbAtlas", + "value": "MongoDbAtlas" + }, + { + "name": "AmazonS3Compatible", + "value": "AmazonS3Compatible" + }, + { + "name": "FileServer", + "value": "FileServer" + }, + { + "name": "FtpServer", + "value": "FtpServer" + }, + { + "name": "GoogleCloudStorage", + "value": "GoogleCloudStorage" + }, + { + "name": "Hdfs", + "value": "Hdfs" + }, + { + "name": "OracleCloudStorage", + "value": "OracleCloudStorage" + }, + { + "name": "Sftp", + "value": "Sftp" + }, + { + "name": "GenericHttp", + "value": "GenericHttp" + }, + { + "name": "ODataRest", + "value": "ODataRest" + }, + { + "name": "Odbc", + "value": "Odbc" + }, + { + "name": "GenericRest", + "value": "GenericRest" + }, + { + "name": "RemoteTool", + "value": "RemoteTool" + }, + { + "name": "AmazonMws", + "value": "AmazonMws" + }, + { + "name": "Concur", + "value": "Concur" + }, + { + "name": "Dynamics", + "value": "Dynamics" + }, + { + "name": "DynamicsAx", + "value": "DynamicsAx" + }, + { + "name": "DynamicsCrm", + "value": "DynamicsCrm" + }, + { + "name": "GoogleAdWords", + "value": "GoogleAdWords" + }, + { + "name": "Hubspot", + "value": "Hubspot" + }, + { + "name": "Jira", + "value": "Jira" + }, + { + "name": "Magento", + "value": "Magento" + }, + { + "name": "Marketo", + "value": "Marketo" + }, + { + "name": "Office365", + "value": "Office365" + }, + { + "name": "Eloqua", + "value": "Eloqua" + }, + { + "name": "Responsys", + "value": "Responsys" + }, + { + "name": "OracleServiceCloud", + "value": "OracleServiceCloud" + }, + { + "name": "PayPal", + "value": "PayPal" + }, + { + "name": "QuickBooks", + "value": "QuickBooks" + }, + { + "name": "Salesforce", + "value": "Salesforce" + }, + { + "name": "SalesforceServiceCloud", + "value": "SalesforceServiceCloud" + }, + { + "name": "SalesforceMarketingCloud", + "value": "SalesforceMarketingCloud" + }, + { + "name": "SapCloudForCustomer", + "value": "SapCloudForCustomer" + }, + { + "name": "SapEcc", + "value": "SapEcc" + }, + { + "name": "ServiceNow", + "value": "ServiceNow" + }, + { + "name": "SharePointOnlineList", + "value": "SharePointOnlineList" + }, + { + "name": "Shopify", + "value": "Shopify" + }, + { + "name": "Square", + "value": "Square" + }, + { + "name": "WebTable", + "value": "WebTable" + }, + { + "name": "Xero", + "value": "Xero" + }, + { + "name": "Zoho", + "value": "Zoho" + }, + { + "name": "GenericContainerRegistry", + "value": "GenericContainerRegistry" + }, + { + "name": "Elasticsearch", + "value": "Elasticsearch" + }, + { + "name": "AppInsights", + "value": "AppInsights" + }, + { + "name": "AppConfig", + "value": "AppConfig" + }, + { + "name": "OpenAI", + "value": "OpenAI" + }, + { + "name": "Serp", + "value": "Serp" + }, + { + "name": "BingLLMSearch", + "value": "BingLLMSearch" + }, + { + "name": "Serverless", + "value": "Serverless" + }, + { + "name": "ManagedOnlineEndpoint", + "value": "ManagedOnlineEndpoint" + }, + { + "name": "ApiManagement", + "value": "ApiManagement" + }, + { + "name": "ModelGateway", + "value": "ModelGateway" + }, + { + "name": "GroundingWithBingSearch", + "value": "GroundingWithBingSearch" + }, + { + "name": "GroundingWithCustomSearch", + "value": "GroundingWithCustomSearch" + }, + { + "name": "Sharepoint", + "value": "Sharepoint" + }, + { + "name": "MicrosoftFabric", + "value": "MicrosoftFabric" + }, + { + "name": "PowerPlatformEnvironment", + "value": "PowerPlatformEnvironment" + }, + { + "name": "RemoteA2A", + "value": "RemoteA2A" + } + ] + } + }, + "ConnectionGroup": { + "type": "string", + "description": "Group based on connection category", + "enum": [ + "Azure", + "AzureAI", + "Database", + "NoSQL", + "File", + "GenericProtocol", + "ServicesAndApps" + ], + "x-ms-enum": { + "name": "ConnectionGroup", + "modelAsString": true, + "values": [ + { + "name": "Azure", + "value": "Azure" + }, + { + "name": "AzureAI", + "value": "AzureAI" + }, + { + "name": "Database", + "value": "Database" + }, + { + "name": "NoSQL", + "value": "NoSQL" + }, + { + "name": "File", + "value": "File" + }, + { + "name": "GenericProtocol", + "value": "GenericProtocol" + }, + { + "name": "ServicesAndApps", + "value": "ServicesAndApps" + } + ] + } + }, + "ConnectionManagedIdentity": { + "type": "object", + "properties": { + "clientId": { + "type": "string" + }, + "resourceId": { + "type": "string" + } + } + }, + "ConnectionOAuth2": { + "type": "object", + "description": "ClientId and ClientSecret are required. Other properties are optional\ndepending on each OAuth2 provider's implementation.", + "properties": { + "authUrl": { + "type": "string", + "format": "uri", + "description": "Required by Concur connection category" + }, + "clientId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "Client id in the format of UUID" + }, + "clientSecret": { + "type": "string", + "format": "password", + "x-ms-secret": true + }, + "developerToken": { + "type": "string", + "format": "password", + "description": "Required by GoogleAdWords connection category", + "x-ms-secret": true + }, + "password": { + "type": "string", + "format": "password", + "x-ms-secret": true + }, + "refreshToken": { + "type": "string", + "format": "password", + "description": "Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho\nwhere user needs to get RefreshToken offline", + "x-ms-secret": true + }, + "tenantId": { + "type": "string", + "description": "Required by QuickBooks and Xero connection categories" + }, + "username": { + "type": "string", + "description": "Concur, ServiceNow auth server AccessToken grant type is 'Password'\nwhich requires UsernamePassword" + } + } + }, + "ConnectionPersonalAccessToken": { + "type": "object", + "properties": { + "pat": { + "type": "string", + "format": "password", + "x-ms-secret": true + } + } + }, + "ConnectionPropertiesV2": { + "type": "object", + "description": "Connection property base schema.", + "properties": { + "authType": { + "$ref": "#/definitions/ConnectionAuthType", + "description": "Authentication type of the connection target" + }, + "category": { + "$ref": "#/definitions/ConnectionCategory", + "description": "Category of the connection" + }, + "createdByWorkspaceArmId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "readOnly": true + }, + "error": { + "type": "string", + "description": "Provides the error message if the connection fails" + }, + "expiryTime": { + "type": "string", + "format": "date-time" + }, + "group": { + "$ref": "#/definitions/ConnectionGroup", + "description": "Group based on connection category", + "readOnly": true + }, + "isSharedToAll": { + "type": "boolean" + }, + "metadata": { + "type": "object", + "description": "Store user metadata for this connection", + "additionalProperties": { + "type": "string" + } + }, + "peRequirement": { + "$ref": "#/definitions/ManagedPERequirement", + "description": "Specifies how private endpoints are used with this connection: 'Required', 'NotRequired', or 'NotApplicable'." + }, + "peStatus": { + "$ref": "#/definitions/ManagedPEStatus", + "description": "Specifies the status of private endpoints for this connection: 'Inactive', 'Active', or 'NotApplicable'." + }, + "sharedUserList": { + "type": "array", + "items": { + "type": "string" + } + }, + "target": { + "type": "string", + "description": "The connection URL to be used." + }, + "useWorkspaceManagedIdentity": { + "type": "boolean" + } + }, + "discriminator": "authType", + "required": [ + "authType" + ] + }, + "ConnectionPropertiesV2BasicResource": { + "type": "object", + "description": "Connection base resource schema.", + "properties": { + "properties": { + "$ref": "#/definitions/ConnectionPropertiesV2", + "description": "Connection property base schema." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ConnectionPropertiesV2BasicResourceArmPaginatedResult": { + "type": "object", + "properties": { + "nextLink": { + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionPropertiesV2BasicResource" + } + } + } + }, + "ConnectionServicePrincipal": { + "type": "object", + "properties": { + "clientId": { + "type": "string" + }, + "clientSecret": { + "type": "string", + "format": "password", + "x-ms-secret": true + }, + "tenantId": { + "type": "string" + } + } + }, + "ConnectionSharedAccessSignature": { + "type": "object", + "properties": { + "sas": { + "type": "string", + "format": "password", + "x-ms-secret": true + } + } + }, + "ConnectionUpdateContent": { + "type": "object", + "description": "The properties that the Cognitive services connection will be updated with.", + "properties": { + "properties": { + "$ref": "#/definitions/ConnectionPropertiesV2", + "description": "The properties that the Cognitive services connection will be updated with." + } + } + }, + "ConnectionUsernamePassword": { + "type": "object", + "properties": { + "password": { + "type": "string", + "format": "password", + "x-ms-secret": true + }, + "securityToken": { + "type": "string", + "format": "password", + "description": "Optional, required by connections like SalesForce for extra security in addition to UsernamePassword", + "x-ms-secret": true + }, + "username": { + "type": "string" + } + } + }, + "ContentLevel": { + "type": "string", + "description": "Level at which content is filtered.", + "enum": [ + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "ContentLevel", + "modelAsString": true, + "values": [ + { + "name": "Low", + "value": "Low" + }, + { + "name": "Medium", + "value": "Medium" + }, + { + "name": "High", + "value": "High" + } + ] + } + }, + "CreatedByType": { + "type": "string", + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "CreatedByType", + "modelAsString": true, + "values": [ + { + "name": "User", + "value": "User" + }, + { + "name": "Application", + "value": "Application" + }, + { + "name": "ManagedIdentity", + "value": "ManagedIdentity" + }, + { + "name": "Key", + "value": "Key" + } + ] + } + }, + "CustomBlocklistConfig": { + "type": "object", + "description": "Gets or sets the source to which filter applies.", + "properties": { + "source": { + "$ref": "#/definitions/RaiPolicyContentSource", + "description": "Content source to apply the Content Filters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/RaiBlocklistConfig" + } + ] + }, + "CustomKeys": { + "type": "object", + "description": "Custom Keys credential object", + "properties": { + "keys": { + "type": "object", + "description": "Dictionary of ", + "additionalProperties": { + "type": "string" + } + } + } + }, + "CustomKeysConnectionProperties": { + "type": "object", + "description": "Category:= CustomKeys\nAuthType:= CustomKeys (as type discriminator)\nCredentials:= {CustomKeys} as CustomKeys\nTarget:= {any value}\nUse Metadata property bag for ApiVersion and other metadata fields", + "properties": { + "credentials": { + "$ref": "#/definitions/CustomKeys", + "description": "Custom Keys credential object" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "x-ms-discriminator-value": "CustomKeys" + }, + "DefenderForAISetting": { + "type": "object", + "description": "The Defender for AI resource.", + "properties": { + "properties": { + "$ref": "#/definitions/DefenderForAISettingProperties", + "description": "The Defender for AI resource properties.", + "x-ms-client-flatten": true + }, + "etag": { + "type": "string", + "description": "Resource Etag.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "DefenderForAISettingProperties": { + "type": "object", + "description": "The Defender for AI resource properties.", + "properties": { + "state": { + "$ref": "#/definitions/DefenderForAISettingState", + "description": "Defender for AI state on the AI resource." + } + } + }, + "DefenderForAISettingResult": { + "type": "object", + "description": "The list of cognitive services Defender for AI Settings.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link used to get the next page of Defender for AI Settings." + }, + "value": { + "type": "array", + "description": "The list of Defender for AI Settings.", + "items": { + "$ref": "#/definitions/DefenderForAISetting" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "DefenderForAISettingState": { + "type": "string", + "description": "Defender for AI state on the AI resource.", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "DefenderForAISettingState", + "modelAsString": true, + "values": [ + { + "name": "Disabled", + "value": "Disabled" + }, + { + "name": "Enabled", + "value": "Enabled" + } + ] + } + }, + "Deployment": { + "type": "object", + "description": "Cognitive Services account deployment.", + "properties": { + "properties": { + "$ref": "#/definitions/DeploymentProperties", + "description": "Properties of Cognitive Services account deployment." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The resource model definition representing SKU" + }, + "etag": { + "type": "string", + "description": "Resource Etag.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "DeploymentCapacitySettings": { + "type": "object", + "description": "Internal use only.", + "properties": { + "designatedCapacity": { + "type": "integer", + "format": "int32", + "description": "The designated capacity.", + "minimum": 0 + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of this capacity setting.", + "minimum": 0 + } + } + }, + "DeploymentListResult": { + "type": "object", + "description": "The list of cognitive services accounts operation response.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link used to get the next page of Deployment." + }, + "value": { + "type": "array", + "description": "Gets the list of Cognitive Services accounts Deployment and their properties.", + "items": { + "$ref": "#/definitions/Deployment" + }, + "readOnly": true + } + } + }, + "DeploymentModel": { + "type": "object", + "description": "Properties of Cognitive Services account deployment model.", + "properties": { + "publisher": { + "type": "string", + "description": "Deployment model publisher." + }, + "format": { + "type": "string", + "description": "Deployment model format." + }, + "name": { + "type": "string", + "description": "Deployment model name." + }, + "version": { + "type": "string", + "description": "Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API." + }, + "source": { + "type": "string", + "description": "Optional. Deployment model source ARM resource ID." + }, + "sourceAccount": { + "type": "string", + "format": "arm-id", + "description": "Optional. Source of the model, another Microsoft.CognitiveServices accounts ARM resource ID.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.CognitiveServices/accounts" + } + ] + } + }, + "callRateLimit": { + "$ref": "#/definitions/CallRateLimit", + "description": "The call rate limit Cognitive Services account.", + "readOnly": true + } + } + }, + "DeploymentModelVersionUpgradeOption": { + "type": "string", + "description": "Deployment model version upgrade option.", + "enum": [ + "OnceNewDefaultVersionAvailable", + "OnceCurrentVersionExpired", + "NoAutoUpgrade" + ], + "x-ms-enum": { + "name": "DeploymentModelVersionUpgradeOption", + "modelAsString": true, + "values": [ + { + "name": "OnceNewDefaultVersionAvailable", + "value": "OnceNewDefaultVersionAvailable" + }, + { + "name": "OnceCurrentVersionExpired", + "value": "OnceCurrentVersionExpired" + }, + { + "name": "NoAutoUpgrade", + "value": "NoAutoUpgrade" + } + ] + } + }, + "DeploymentProperties": { + "type": "object", + "description": "Properties of Cognitive Services account deployment.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/DeploymentProvisioningState", + "description": "Gets the status of the resource at the time the operation was called.", + "readOnly": true + }, + "model": { + "$ref": "#/definitions/DeploymentModel", + "description": "Properties of Cognitive Services account deployment model." + }, + "scaleSettings": { + "$ref": "#/definitions/DeploymentScaleSettings", + "description": "Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.)" + }, + "capabilities": { + "type": "object", + "description": "The capabilities.", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "raiPolicyName": { + "type": "string", + "description": "The name of RAI policy." + }, + "callRateLimit": { + "$ref": "#/definitions/CallRateLimit", + "description": "The call rate limit Cognitive Services account.", + "readOnly": true + }, + "rateLimits": { + "type": "array", + "items": { + "$ref": "#/definitions/ThrottlingRule" + }, + "readOnly": true, + "x-ms-identifiers": [ + "key" + ] + }, + "versionUpgradeOption": { + "$ref": "#/definitions/DeploymentModelVersionUpgradeOption", + "description": "Deployment model version upgrade option." + }, + "dynamicThrottlingEnabled": { + "type": "boolean", + "description": "If the dynamic throttling is enabled.", + "readOnly": true + }, + "currentCapacity": { + "type": "integer", + "format": "int32", + "description": "The current capacity." + }, + "capacitySettings": { + "$ref": "#/definitions/DeploymentCapacitySettings", + "description": "Internal use only." + }, + "parentDeploymentName": { + "type": "string", + "description": "The name of parent deployment." + }, + "spilloverDeploymentName": { + "type": "string", + "description": "Specifies the deployment name that should serve requests when the request would have otherwise been throttled due to reaching current deployment throughput limit." + }, + "serviceTier": { + "$ref": "#/definitions/ServiceTier", + "description": "The service tier for the deployment. Determines the pricing and performance level for request processing. Use 'Default' for standard pricing or 'Priority' for higher-priority processing with premium pricing. Note: Pause operations are only supported on Standard, DataZoneStandard, and GlobalStandard SKUs.", + "x-nullable": true + }, + "deploymentState": { + "$ref": "#/definitions/DeploymentState", + "description": "The state of the deployment. Controls whether the deployment is accepting inference requests. Use 'Running' for active deployments that process requests, or 'Paused' to temporarily stop inference while preserving the deployment configuration.", + "x-nullable": true + }, + "routing": { + "$ref": "#/definitions/DeploymentRouting", + "description": "Routing configuration for the model-router deployment. This property is only applicable when the deployed model is 'model-router' version 2025-11-18 or later. Allows you to select the models subset for routing and the routing mode (balanced, quality, cost) for routing across all supported models or the model subset." + } + } + }, + "DeploymentProvisioningState": { + "type": "string", + "description": "Gets the status of the resource at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Deleting", + "Moving", + "Failed", + "Succeeded", + "Disabled", + "Canceled" + ], + "x-ms-enum": { + "name": "DeploymentProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Accepted", + "value": "Accepted" + }, + { + "name": "Creating", + "value": "Creating" + }, + { + "name": "Deleting", + "value": "Deleting" + }, + { + "name": "Moving", + "value": "Moving" + }, + { + "name": "Failed", + "value": "Failed" + }, + { + "name": "Succeeded", + "value": "Succeeded" + }, + { + "name": "Disabled", + "value": "Disabled" + }, + { + "name": "Canceled", + "value": "Canceled" + } + ] + }, + "readOnly": true + }, + "DeploymentRouting": { + "type": "object", + "description": "Routing configuration for the model-router deployment. Specifies how requests are routed across multiple models.", + "properties": { + "mode": { + "type": "string", + "description": "The model-router routing mode that determines how requests are distributed across models.", + "default": "balanced", + "enum": [ + "cost", + "balanced", + "quality" + ], + "x-ms-enum": { + "name": "RoutingMode", + "modelAsString": true, + "values": [ + { + "name": "Cost", + "value": "cost", + "description": "Route requests to minimize cost while meeting performance requirements." + }, + { + "name": "Balanced", + "value": "balanced", + "description": "Balance cost and quality when routing requests across models." + }, + { + "name": "Quality", + "value": "quality", + "description": "Route requests to maximize quality regardless of cost." + } + ] + } + }, + "models": { + "type": "array", + "description": "Optional. The list of model-router supported models that the model router can use to route requests across. If not specified, the model router will route to all available models specified in the model-router version.", + "items": { + "$ref": "#/definitions/DeploymentModel" + }, + "x-ms-identifiers": [ + "name", + "version" + ] + } + } + }, + "DeploymentScaleSettings": { + "type": "object", + "description": "Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.)", + "properties": { + "scaleType": { + "$ref": "#/definitions/DeploymentScaleType", + "description": "Deployment scale type." + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "Deployment capacity." + }, + "activeCapacity": { + "type": "integer", + "format": "int32", + "description": "Deployment active capacity. This value might be different from `capacity` if customer recently updated `capacity`.", + "readOnly": true + } + } + }, + "DeploymentScaleType": { + "type": "string", + "description": "Deployment scale type.", + "enum": [ + "Standard", + "Manual" + ], + "x-ms-enum": { + "name": "DeploymentScaleType", + "modelAsString": true, + "values": [ + { + "name": "Standard", + "value": "Standard" + }, + { + "name": "Manual", + "value": "Manual" + } + ] + } + }, + "DeploymentSkuListResult": { + "type": "object", + "description": "The list of cognitive services accounts operation response.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link used to get the next page of deployment skus." + }, + "value": { + "type": "array", + "description": "Gets the list of Cognitive Services accounts deployment skus.", + "items": { + "$ref": "#/definitions/SkuResource" + }, + "readOnly": true, + "x-ms-identifiers": [ + "resourceType" + ] + } + } + }, + "DeploymentState": { + "type": "string", + "description": "The state of the deployment. Controls whether the deployment is accepting inference requests. Use 'Running' for active deployments that process requests, or 'Paused' to temporarily stop inference while preserving the deployment configuration.", + "enum": [ + "Running", + "Paused" + ], + "x-ms-enum": { + "name": "DeploymentState", + "modelAsString": true, + "values": [ + { + "name": "Running", + "value": "Running", + "description": "The deployment is running and accepting inference requests." + }, + { + "name": "Paused", + "value": "Paused", + "description": "The deployment is paused and not accepting inference requests." + } + ] + } + }, + "DeprecationStatus": { + "type": "string", + "description": "Indicates whether the deprecation date is a confirmed planned end-of-life date or an estimated deprecation date. When 'Planned', the deprecation date represents a confirmed and communicated model end-of-life date. When 'Tentative', the deprecation date is an estimated timeline that may be subject to change.", + "enum": [ + "Planned", + "Tentative" + ], + "x-ms-enum": { + "name": "DeprecationStatus", + "modelAsString": true, + "values": [ + { + "name": "Planned", + "value": "Planned" + }, + { + "name": "Tentative", + "value": "Tentative" + } + ] + } + }, + "DomainAvailability": { + "type": "object", + "description": "Domain availability.", + "properties": { + "isSubdomainAvailable": { + "type": "boolean", + "description": "Indicates the given SKU is available or not." + }, + "reason": { + "type": "string", + "description": "Reason why the SKU is not available." + }, + "subdomainName": { + "type": "string", + "description": "The subdomain name to use." + }, + "type": { + "type": "string", + "description": "The Type of the resource." + }, + "kind": { + "type": "string", + "description": "The kind (type) of cognitive service account." + } + } + }, + "Encryption": { + "type": "object", + "description": "Properties to configure Encryption", + "properties": { + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Properties of KeyVault" + }, + "keySource": { + "type": "string", + "description": "Enumerates the possible value of keySource for Encryption", + "default": "Microsoft.KeyVault", + "enum": [ + "Microsoft.CognitiveServices", + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "KeySource", + "modelAsString": true, + "values": [ + { + "name": "Microsoft.CognitiveServices", + "value": "Microsoft.CognitiveServices" + }, + { + "name": "Microsoft.KeyVault", + "value": "Microsoft.KeyVault" + } + ] + } + } + } + }, + "EncryptionScope": { + "type": "object", + "description": "Cognitive Services EncryptionScope", + "properties": { + "properties": { + "$ref": "#/definitions/EncryptionScopeProperties", + "description": "Properties of Cognitive Services EncryptionScope." + }, + "etag": { + "type": "string", + "description": "Resource Etag.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "EncryptionScopeListResult": { + "type": "object", + "description": "The list of cognitive services EncryptionScopes.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link used to get the next page of EncryptionScope." + }, + "value": { + "type": "array", + "description": "The list of EncryptionScope.", + "items": { + "$ref": "#/definitions/EncryptionScope" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "EncryptionScopeProperties": { + "type": "object", + "description": "Properties to EncryptionScope", + "properties": { + "provisioningState": { + "$ref": "#/definitions/EncryptionScopeProvisioningState", + "description": "Gets the status of the resource at the time the operation was called.", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/EncryptionScopeState", + "description": "The encryptionScope state." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Encryption" + } + ] + }, + "EncryptionScopeProvisioningState": { + "type": "string", + "description": "Gets the status of the resource at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Deleting", + "Moving", + "Failed", + "Succeeded", + "Canceled" + ], + "x-ms-enum": { + "name": "EncryptionScopeProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Accepted", + "value": "Accepted" + }, + { + "name": "Creating", + "value": "Creating" + }, + { + "name": "Deleting", + "value": "Deleting" + }, + { + "name": "Moving", + "value": "Moving" + }, + { + "name": "Failed", + "value": "Failed" + }, + { + "name": "Succeeded", + "value": "Succeeded" + }, + { + "name": "Canceled", + "value": "Canceled" + } + ] + }, + "readOnly": true + }, + "EncryptionScopeState": { + "type": "string", + "description": "The encryptionScope state.", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "EncryptionScopeState", + "modelAsString": true, + "values": [ + { + "name": "Disabled", + "value": "Disabled" + }, + { + "name": "Enabled", + "value": "Enabled" + } + ] + } + }, + "FirewallSku": { + "type": "string", + "description": "Firewall Sku used for FQDN Rules", + "enum": [ + "Standard", + "Basic" + ], + "x-ms-enum": { + "name": "FirewallSku", + "modelAsString": true, + "values": [ + { + "name": "Standard", + "value": "Standard" + }, + { + "name": "Basic", + "value": "Basic" + } + ] + } + }, + "FqdnOutboundRule": { + "type": "object", + "description": "FQDN Outbound Rule for the managed network of a cognitive services account.", + "properties": { + "destination": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/definitions/OutboundRule" + } + ], + "x-ms-discriminator-value": "FQDN" + }, + "HostedAgentDeployment": { + "type": "object", + "description": "Represents a hosted agent deployment where the underlying infrastructure is owned by the platform.", + "properties": { + "minReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the minimum number of replicas for this hosted deployment.", + "minimum": 0 + }, + "maxReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the maximum number of replicas for this hosted deployment.", + "minimum": 0 + } + }, + "allOf": [ + { + "$ref": "#/definitions/AgentDeploymentProperties" + } + ], + "x-ms-discriminator-value": "Hosted" + }, + "HostingModel": { + "type": "string", + "description": "Account hosting model.", + "enum": [ + "Web", + "ConnectedContainer", + "DisconnectedContainer", + "ProvisionedWeb" + ], + "x-ms-enum": { + "name": "HostingModel", + "modelAsString": true, + "values": [ + { + "name": "Web", + "value": "Web" + }, + { + "name": "ConnectedContainer", + "value": "ConnectedContainer" + }, + { + "name": "DisconnectedContainer", + "value": "DisconnectedContainer" + }, + { + "name": "ProvisionedWeb", + "value": "ProvisionedWeb" + } + ] + } + }, + "Identity": { + "type": "object", + "description": "Identity for the resource.", + "properties": { + "type": { + "$ref": "#/definitions/ResourceIdentityType", + "description": "The identity type." + }, + "tenantId": { + "type": "string", + "description": "The tenant ID of resource.", + "readOnly": true + }, + "principalId": { + "type": "string", + "description": "The principal ID of resource identity.", + "readOnly": true + }, + "userAssignedIdentities": { + "type": "object", + "description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + } + } + } + }, + "IdentityKind": { + "type": "string", + "description": "Specifies the kind of Entra identity described by this object.", + "enum": [ + "AgentBlueprint", + "AgentInstance", + "AgenticUser", + "Managed", + "None" + ], + "x-ms-enum": { + "name": "IdentityKind", + "modelAsString": true, + "values": [ + { + "name": "AgentBlueprint", + "value": "AgentBlueprint", + "description": "Represents a class identity, used for agentic applications." + }, + { + "name": "AgentInstance", + "value": "AgentInstance", + "description": "Represents an instance identity." + }, + { + "name": "AgenticUser", + "value": "AgenticUser", + "description": "Represents an agentic instance identity with user-like traits." + }, + { + "name": "Managed", + "value": "Managed", + "description": "Represents a classic managed identity." + }, + { + "name": "None", + "value": "None", + "description": "No identity." + } + ] + } + }, + "IdentityManagementType": { + "type": "string", + "description": "Enumeration of identity types, from the perspective of management.", + "enum": [ + "System", + "User", + "None" + ], + "x-ms-enum": { + "name": "IdentityManagementType", + "modelAsString": true, + "values": [ + { + "name": "System", + "value": "System", + "description": "Platform-managed identity." + }, + { + "name": "User", + "value": "User", + "description": "User-managed identity." + }, + { + "name": "None", + "value": "None", + "description": "No identity." + } + ] + } + }, + "IdentityProvisioningState": { + "type": "string", + "description": "Represents the provisioning state of an identity resource.", + "enum": [ + "Creating", + "Updating", + "Succeeded", + "Failed", + "Canceled", + "Deleting" + ], + "x-ms-enum": { + "name": "IdentityProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Creating", + "value": "Creating", + "description": "Identity is being created." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Identity is being updated." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Identity has been successfully provisioned." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Identity provisioning has failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Identity provisioning has been canceled." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Identity is being deleted." + } + ] + }, + "readOnly": true + }, + "IpRule": { + "type": "object", + "description": "A rule governing the accessibility from a specific ip address or ip range.", + "properties": { + "value": { + "type": "string", + "description": "An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78)." + } + }, + "required": [ + "value" + ] + }, + "IsolationMode": { + "type": "string", + "description": "Isolation mode for the managed network of a cognitive services account.", + "enum": [ + "Disabled", + "AllowInternetOutbound", + "AllowOnlyApprovedOutbound" + ], + "x-ms-enum": { + "name": "IsolationMode", + "modelAsString": true, + "values": [ + { + "name": "Disabled", + "value": "Disabled" + }, + { + "name": "AllowInternetOutbound", + "value": "AllowInternetOutbound" + }, + { + "name": "AllowOnlyApprovedOutbound", + "value": "AllowOnlyApprovedOutbound" + } + ] + } + }, + "KeyName": { + "type": "string", + "description": "key name to generate (Key1|Key2)", + "enum": [ + "Key1", + "Key2" + ], + "x-ms-enum": { + "name": "KeyName", + "modelAsString": false + } + }, + "KeySource": { + "type": "string", + "description": "Enumerates the possible value of keySource for Encryption", + "enum": [ + "Microsoft.CognitiveServices", + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "KeySource", + "modelAsString": true, + "values": [ + { + "name": "Microsoft.CognitiveServices", + "value": "Microsoft.CognitiveServices" + }, + { + "name": "Microsoft.KeyVault", + "value": "Microsoft.KeyVault" + } + ] + } + }, + "KeyVaultProperties": { + "type": "object", + "description": "Properties to configure keyVault Properties", + "properties": { + "keyName": { + "type": "string", + "description": "Name of the Key from KeyVault" + }, + "keyVersion": { + "type": "string", + "description": "Version of the Key from KeyVault" + }, + "keyVaultUri": { + "type": "string", + "description": "Uri of KeyVault" + }, + "identityClientId": { + "type": "string" + } + } + }, + "ManagedAgentDeployment": { + "type": "object", + "description": "Represents a managed agent deployment where the underlying infrastructure is managed by the platform in the deployer's subscription.", + "allOf": [ + { + "$ref": "#/definitions/AgentDeploymentProperties" + } + ], + "x-ms-discriminator-value": "Managed" + }, + "ManagedIdentityAuthTypeConnectionProperties": { + "type": "object", + "properties": { + "credentials": { + "$ref": "#/definitions/ConnectionManagedIdentity" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "x-ms-discriminator-value": "ManagedIdentity" + }, + "ManagedNetworkKind": { + "type": "string", + "description": "The Kind of the managed network. Users can switch from V1 to V2 for granular access controls, but cannot switch back to V1 once V2 is enabled.", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "ManagedNetworkKind", + "modelAsString": true, + "values": [ + { + "name": "V1", + "value": "V1" + }, + { + "name": "V2", + "value": "V2" + } + ] + } + }, + "ManagedNetworkListResult": { + "type": "object", + "description": "List of managed networks of a cognitive services account.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages." + }, + "value": { + "type": "array", + "description": "The list of managed network settings of an account. Since this list may be incomplete, the nextLink field should be used to request the next list of cognitive services accounts.", + "items": { + "$ref": "#/definitions/ManagedNetworkSettingsPropertiesBasicResource" + } + } + } + }, + "ManagedNetworkProvisionOptions": { + "type": "object", + "description": "Managed Network Provisioning options for managed network of a cognitive services account." + }, + "ManagedNetworkProvisionStatus": { + "type": "object", + "description": "Status of the Provisioning for the managed network of a cognitive services account.", + "properties": { + "status": { + "$ref": "#/definitions/ManagedNetworkStatus", + "description": "Status for the managed network of a cognitive services account." + } + } + }, + "ManagedNetworkProvisioningState": { + "type": "string", + "enum": [ + "Deferred", + "Updating", + "Succeeded", + "Failed", + "Deleting", + "Deleted" + ], + "x-ms-enum": { + "name": "ManagedNetworkProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Deferred", + "value": "Deferred" + }, + { + "name": "Updating", + "value": "Updating" + }, + { + "name": "Succeeded", + "value": "Succeeded" + }, + { + "name": "Failed", + "value": "Failed" + }, + { + "name": "Deleting", + "value": "Deleting" + }, + { + "name": "Deleted", + "value": "Deleted" + } + ] + }, + "readOnly": true + }, + "ManagedNetworkSettings": { + "type": "object", + "description": "Managed Network settings for a cognitive services account.", + "properties": { + "isolationMode": { + "$ref": "#/definitions/IsolationMode", + "description": "Isolation mode for the managed network of a cognitive services account." + }, + "networkId": { + "type": "string", + "readOnly": true + }, + "outboundRules": { + "type": "object", + "description": "Dictionary of ", + "x-nullable": true, + "additionalProperties": { + "$ref": "#/definitions/OutboundRule" + } + }, + "status": { + "$ref": "#/definitions/ManagedNetworkProvisionStatus", + "description": "Status of the Provisioning for the managed network of a cognitive services account." + }, + "firewallSku": { + "$ref": "#/definitions/FirewallSku", + "description": "Firewall Sku used for FQDN Rules" + }, + "managedNetworkKind": { + "$ref": "#/definitions/ManagedNetworkKind", + "description": "The Kind of the managed network. Users can switch from V1 to V2 for granular access controls, but cannot switch back to V1 once V2 is enabled." + }, + "firewallPublicIpAddress": { + "type": "string", + "description": "Public IP address assigned to the Azure Firewall.", + "x-nullable": true, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ManagedNetworkProvisioningState", + "description": "The provisioning state of the managed network settings.", + "readOnly": true + } + } + }, + "ManagedNetworkSettingsBasicResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ManagedNetworkSettings", + "description": "Managed Network settings for a cognitive services account." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ] + }, + "ManagedNetworkSettingsEx": { + "type": "object", + "properties": { + "changeableIsolationModes": { + "type": "array", + "items": { + "$ref": "#/definitions/IsolationMode" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ManagedNetworkSettings" + } + ] + }, + "ManagedNetworkSettingsProperties": { + "type": "object", + "description": "The properties of the managed network settings of a cognitive services account.", + "properties": { + "managedNetwork": { + "$ref": "#/definitions/ManagedNetworkSettingsEx", + "description": "Managed Network settings for a cognitive services account." + }, + "provisioningState": { + "$ref": "#/definitions/ManagedNetworkProvisioningState", + "description": "The current deployment state of the managed network resource. The provisioningState is to indicate states for resource provisioning.", + "readOnly": true + } + } + }, + "ManagedNetworkSettingsPropertiesBasicResource": { + "type": "object", + "description": "Concrete proxy resource types can be created by aliasing this type using a specific property type.", + "properties": { + "properties": { + "$ref": "#/definitions/ManagedNetworkSettingsProperties", + "description": "The properties of the managed network settings of a cognitive services account." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ManagedNetworkStatus": { + "type": "string", + "description": "Status for the managed network of a cognitive services account.", + "enum": [ + "Inactive", + "Active" + ], + "x-ms-enum": { + "name": "ManagedNetworkStatus", + "modelAsString": true, + "values": [ + { + "name": "Inactive", + "value": "Inactive" + }, + { + "name": "Active", + "value": "Active" + } + ] + } + }, + "ManagedPERequirement": { + "type": "string", + "enum": [ + "Required", + "NotRequired", + "NotApplicable" + ], + "x-ms-enum": { + "name": "ManagedPERequirement", + "modelAsString": true, + "values": [ + { + "name": "Required", + "value": "Required" + }, + { + "name": "NotRequired", + "value": "NotRequired" + }, + { + "name": "NotApplicable", + "value": "NotApplicable" + } + ] + } + }, + "ManagedPEStatus": { + "type": "string", + "enum": [ + "Inactive", + "Active", + "NotApplicable" + ], + "x-ms-enum": { + "name": "ManagedPEStatus", + "modelAsString": true, + "values": [ + { + "name": "Inactive", + "value": "Inactive" + }, + { + "name": "Active", + "value": "Active" + }, + { + "name": "NotApplicable", + "value": "NotApplicable" + } + ] + } + }, + "MetricName": { + "type": "object", + "description": "A metric name.", + "properties": { + "value": { + "type": "string", + "description": "The name of the metric." + }, + "localizedValue": { + "type": "string", + "description": "The friendly name of the metric." + } + } + }, + "Model": { + "type": "object", + "description": "Cognitive Services Model.", + "properties": { + "model": { + "$ref": "#/definitions/AccountModel", + "description": "Cognitive Services account Model." + }, + "kind": { + "type": "string", + "description": "The kind (type) of cognitive service account." + }, + "skuName": { + "type": "string", + "description": "The name of SKU." + }, + "description": { + "type": "string", + "description": "The description of the model." + } + } + }, + "ModelCapacityCalculatorWorkload": { + "type": "object", + "description": "Model Capacity Calculator Workload.", + "properties": { + "requestPerMinute": { + "type": "integer", + "format": "int64", + "description": "Request per minute." + }, + "requestParameters": { + "$ref": "#/definitions/ModelCapacityCalculatorWorkloadRequestParam", + "description": "Dictionary, Model Capacity Calculator Workload Parameters." + } + } + }, + "ModelCapacityCalculatorWorkloadRequestParam": { + "type": "object", + "description": "Dictionary, Model Capacity Calculator Workload Parameters.", + "properties": { + "avgPromptTokens": { + "type": "integer", + "format": "int64", + "description": "Average prompt tokens." + }, + "avgGeneratedTokens": { + "type": "integer", + "format": "int64", + "description": "Average generated tokens." + } + } + }, + "ModelCapacityListResult": { + "type": "object", + "description": "The list of cognitive services accounts operation response.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link used to get the next page of ModelSkuCapacity." + }, + "value": { + "type": "array", + "description": "Gets the list of Cognitive Services accounts ModelSkuCapacity.", + "items": { + "$ref": "#/definitions/ModelCapacityListResultValueItem" + }, + "readOnly": true, + "x-ms-identifiers": [ + "model" + ] + } + } + }, + "ModelCapacityListResultValueItem": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The location of the Model Sku Capacity." + }, + "properties": { + "$ref": "#/definitions/ModelSkuCapacityProperties", + "description": "Cognitive Services account ModelSkuCapacity." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ModelDeprecationInfo": { + "type": "object", + "description": "Cognitive Services account ModelDeprecationInfo.", + "properties": { + "fineTune": { + "type": "string", + "description": "The datetime of deprecation of the fineTune Model." + }, + "inference": { + "type": "string", + "description": "The datetime of deprecation of the inference Model." + }, + "deprecationStatus": { + "$ref": "#/definitions/DeprecationStatus", + "description": "Indicates whether the deprecation date is a confirmed planned end-of-life date or an estimated deprecation date. When 'Planned', the deprecation date represents a confirmed and communicated model end-of-life date. When 'Tentative', the deprecation date is an estimated timeline that may be subject to change." + } + } + }, + "ModelLifecycleStatus": { + "type": "string", + "description": "Model lifecycle status.", + "enum": [ + "Stable", + "Preview", + "GenerallyAvailable", + "Deprecating", + "Deprecated", + "Legacy" + ], + "x-ms-enum": { + "name": "ModelLifecycleStatus", + "modelAsString": true, + "values": [ + { + "name": "Stable", + "value": "Stable", + "description": "Legacy state. Replaced with GenerallyAvailable going forward." + }, + { + "name": "Preview", + "value": "Preview", + "description": "Model is in preview and may be subject to changes." + }, + { + "name": "GenerallyAvailable", + "value": "GenerallyAvailable", + "description": "Model is generally available for production use." + }, + { + "name": "Deprecating", + "value": "Deprecating", + "description": "Model is being deprecated and will be removed in the future. Only customers with existing deployments can create new deployments with this model." + }, + { + "name": "Deprecated", + "value": "Deprecated", + "description": "Model has been deprecated, also known as retired, and is no longer supported. Inference calls to deployments of models in this lifecycle state will return 410 errors." + }, + { + "name": "Legacy", + "value": "Legacy", + "description": "Model is a legacy version that is no longer recommended for use. Customers should migrate to newer models. Check replacementConfig for upgrade information." + } + ] + } + }, + "ModelListResult": { + "type": "object", + "description": "The list of cognitive services models.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link used to get the next page of Model." + }, + "value": { + "type": "array", + "description": "Gets the list of Cognitive Services accounts Model and their properties.", + "items": { + "$ref": "#/definitions/Model" + }, + "x-ms-identifiers": [ + "kind", + "skuName", + "/model/name", + "/model/format", + "/model/version" + ] + } + } + }, + "ModelSku": { + "type": "object", + "description": "Describes an available Cognitive Services Model SKU.", + "properties": { + "name": { + "type": "string", + "description": "The name of the model SKU." + }, + "usageName": { + "type": "string", + "description": "The usage name of the model SKU." + }, + "deprecationDate": { + "type": "string", + "format": "date-time", + "description": "The datetime of deprecation of the model SKU." + }, + "capacity": { + "$ref": "#/definitions/CapacityConfig", + "description": "The capacity configuration." + }, + "rateLimits": { + "type": "array", + "description": "The list of rateLimit.", + "items": { + "$ref": "#/definitions/CallRateLimit" + }, + "x-ms-identifiers": [] + }, + "cost": { + "type": "array", + "description": "The list of billing meter info.", + "items": { + "$ref": "#/definitions/BillingMeterInfo" + }, + "x-ms-identifiers": [] + } + } + }, + "ModelSkuCapacityProperties": { + "type": "object", + "description": "Cognitive Services account ModelSkuCapacity.", + "properties": { + "model": { + "$ref": "#/definitions/DeploymentModel", + "description": "Properties of Cognitive Services account deployment model." + }, + "skuName": { + "type": "string" + }, + "availableCapacity": { + "type": "number", + "format": "float", + "description": "The available capacity for deployment with this model and sku." + }, + "availableFinetuneCapacity": { + "type": "number", + "format": "float", + "description": "The available capacity for deployment with a fine-tune version of this model and sku." + } + } + }, + "MultiRegionSettings": { + "type": "object", + "description": "The multiregion settings Cognitive Services account.", + "properties": { + "routingMethod": { + "$ref": "#/definitions/RoutingMethods", + "description": "Multiregion routing methods." + }, + "regions": { + "type": "array", + "items": { + "$ref": "#/definitions/RegionSetting" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "NetworkInjection": { + "type": "object", + "description": "Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources.", + "properties": { + "scenario": { + "$ref": "#/definitions/ScenarioType", + "description": "Specifies what features in AI Foundry network injection applies to. Currently only supports 'agent' for agent scenarios. 'none' means no network injection." + }, + "subnetArmId": { + "type": "string", + "format": "arm-id", + "description": "Specify the subnet for which your Agent Client is injected into.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + } + }, + "useMicrosoftManagedNetwork": { + "type": "boolean", + "description": "Boolean to enable Microsoft Managed Network for subnet delegation" + } + } + }, + "NetworkRuleAction": { + "type": "string", + "description": "The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "NetworkRuleAction", + "modelAsString": true, + "values": [ + { + "name": "Allow", + "value": "Allow" + }, + { + "name": "Deny", + "value": "Deny" + } + ] + } + }, + "NetworkRuleSet": { + "type": "object", + "description": "A set of rules governing the network accessibility.", + "properties": { + "defaultAction": { + "$ref": "#/definitions/NetworkRuleAction", + "description": "The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated." + }, + "bypass": { + "$ref": "#/definitions/ByPassSelection", + "description": "Setting for trusted services." + }, + "ipRules": { + "type": "array", + "description": "The list of IP address rules.", + "items": { + "$ref": "#/definitions/IpRule" + }, + "x-ms-identifiers": [] + }, + "virtualNetworkRules": { + "type": "array", + "description": "The list of virtual network rules.", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + } + } + } + }, + "NetworkSecurityPerimeter": { + "type": "object", + "description": "Information about a linked Network Security Perimeter", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Fully qualified identifier of the resource" + }, + "perimeterGuid": { + "type": "string", + "description": "Guid of the resource" + }, + "location": { + "type": "string", + "description": "Location of the resource" + } + } + }, + "NetworkSecurityPerimeterAccessRule": { + "type": "object", + "description": "Network Security Perimeter Access Rule", + "properties": { + "name": { + "type": "string", + "description": "Network Security Perimeter Access Rule Name" + }, + "properties": { + "$ref": "#/definitions/NetworkSecurityPerimeterAccessRuleProperties", + "description": "Properties of Network Security Perimeter Access Rule" + } + } + }, + "NetworkSecurityPerimeterAccessRuleProperties": { + "type": "object", + "description": "The Properties of Network Security Perimeter Rule", + "properties": { + "direction": { + "$ref": "#/definitions/NspAccessRuleDirection", + "description": "Direction of Access Rule" + }, + "addressPrefixes": { + "type": "array", + "description": "Address prefixes for inbound rules", + "items": { + "type": "string" + } + }, + "subscriptions": { + "type": "array", + "description": "Subscriptions for inbound rules", + "items": { + "$ref": "#/definitions/NetworkSecurityPerimeterAccessRulePropertiesSubscriptionsItem" + } + }, + "networkSecurityPerimeters": { + "type": "array", + "description": "NetworkSecurityPerimeters for inbound rules", + "items": { + "$ref": "#/definitions/NetworkSecurityPerimeter" + } + }, + "fullyQualifiedDomainNames": { + "type": "array", + "description": "Fully qualified domain name for outbound rules", + "items": { + "type": "string" + } + } + } + }, + "NetworkSecurityPerimeterAccessRulePropertiesSubscriptionsItem": { + "type": "object", + "description": "Subscription for inbound rule", + "properties": { + "id": { + "type": "string", + "description": "Fully qualified identifier of subscription" + } + } + }, + "NetworkSecurityPerimeterConfiguration": { + "type": "object", + "description": "NSP Configuration for an Cognitive Services account.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationProperties", + "description": "NSP Configuration properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "NetworkSecurityPerimeterConfigurationAssociationInfo": { + "type": "object", + "description": "Network Security Perimeter Configuration Association Information", + "properties": { + "name": { + "type": "string", + "description": "Name of the resource association" + }, + "accessMode": { + "type": "string", + "description": "Access Mode of the resource association" + } + } + }, + "NetworkSecurityPerimeterConfigurationList": { + "type": "object", + "description": "A list of NSP configurations for an Cognitive Services account.", + "properties": { + "value": { + "type": "array", + "description": "Array of NSP configurations List Result for an Cognitive Services account.", + "items": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfiguration" + }, + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "type": "string", + "description": "Link to retrieve next page of results." + } + } + }, + "NetworkSecurityPerimeterConfigurationProperties": { + "type": "object", + "description": "The properties of an NSP Configuration.", + "properties": { + "provisioningState": { + "type": "string", + "description": "Provisioning state of NetworkSecurityPerimeter configuration", + "readOnly": true + }, + "provisioningIssues": { + "type": "array", + "description": "List of Provisioning Issues", + "items": { + "$ref": "#/definitions/ProvisioningIssue" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "networkSecurityPerimeter": { + "$ref": "#/definitions/NetworkSecurityPerimeter", + "description": "Information about a linked Network Security Perimeter" + }, + "resourceAssociation": { + "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationAssociationInfo", + "description": "Network Security Perimeter Configuration Association Information" + }, + "profile": { + "$ref": "#/definitions/NetworkSecurityPerimeterProfileInfo", + "description": "Network Security Perimeter Profile Information" + } + } + }, + "NetworkSecurityPerimeterProfileInfo": { + "type": "object", + "description": "Network Security Perimeter Profile Information", + "properties": { + "name": { + "type": "string", + "description": "Name of the resource profile" + }, + "accessRulesVersion": { + "type": "integer", + "format": "int64", + "description": "Access rules version of the resource profile" + }, + "accessRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityPerimeterAccessRule" + }, + "x-ms-identifiers": [] + }, + "diagnosticSettingsVersion": { + "type": "integer", + "format": "int64", + "description": "Current diagnostic settings version" + }, + "enabledLogCategories": { + "type": "array", + "description": "List of enabled log categories", + "items": { + "type": "string" + } + } + } + }, + "NoneAuthTypeConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "x-ms-discriminator-value": "None" + }, + "NspAccessRuleDirection": { + "type": "string", + "description": "Direction of Access Rule", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "NspAccessRuleDirection", + "modelAsString": true, + "values": [ + { + "name": "Inbound", + "value": "Inbound" + }, + { + "name": "Outbound", + "value": "Outbound" + } + ] + } + }, + "OAuth2AuthTypeConnectionProperties": { + "type": "object", + "properties": { + "credentials": { + "$ref": "#/definitions/ConnectionOAuth2", + "description": "ClientId and ClientSecret are required. Other properties are optional\ndepending on each OAuth2 provider's implementation." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "x-ms-discriminator-value": "OAuth2" + }, + "OrganizationSharedBuiltInAuthorizationPolicy": { + "type": "object", + "description": "Built-in authorization policy scoped to organization/tenant.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationAuthorizationPolicy" + } + ], + "x-ms-discriminator-value": "OrganizationScope" + }, + "Origin": { + "type": "string", + "description": "The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is \"user,system\"", + "enum": [ + "user", + "system", + "user,system" + ], + "x-ms-enum": { + "name": "Origin", + "modelAsString": true, + "values": [ + { + "name": "user", + "value": "user" + }, + { + "name": "system", + "value": "system" + }, + { + "name": "user,system", + "value": "user,system" + } + ] + } + }, + "OutboundRule": { + "type": "object", + "description": "Outbound Rule for the managed network of a cognitive services account.", + "properties": { + "category": { + "$ref": "#/definitions/RuleCategory", + "description": "Category of a managed network Outbound Rule of a cognitive services account." + }, + "status": { + "$ref": "#/definitions/RuleStatus", + "description": "Type of a managed network Outbound Rule of a cognitive services account." + }, + "type": { + "$ref": "#/definitions/RuleType", + "description": "Type of a managed network Outbound Rule of a cognitive services account." + }, + "errorInformation": { + "type": "string", + "description": "Error information about an outbound rule of a cognitive services account if RuleStatus is failed.", + "readOnly": true + }, + "parentRuleNames": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + }, + "discriminator": "type", + "required": [ + "type" + ] + }, + "OutboundRuleBasicResource": { + "type": "object", + "description": "Concrete proxy resource types can be created by aliasing this type using a specific property type.", + "properties": { + "properties": { + "$ref": "#/definitions/OutboundRule", + "description": "Outbound Rule for the managed network of a cognitive services account." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "OutboundRuleListResult": { + "type": "object", + "description": "List of outbound rules for the managed network of a cognitive services account.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages." + }, + "value": { + "type": "array", + "description": "The list of cognitive services accounts. Since this list may be incomplete, the nextLink field should be used to request the next list of cognitive services accounts.", + "items": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + } + } + }, + "PATAuthTypeConnectionProperties": { + "type": "object", + "properties": { + "credentials": { + "$ref": "#/definitions/ConnectionPersonalAccessToken" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "x-ms-discriminator-value": "PAT" + }, + "PatchResourceTags": { + "type": "object", + "description": "The object being used to update tags of a resource, in general used for PATCH operations.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "PatchResourceTagsAndSku": { + "type": "object", + "description": "The object being used to update tags and sku of a resource, in general used for PATCH operations.", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The resource model definition representing SKU" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PatchResourceTags" + } + ] + }, + "PrivateEndpointConnection": { + "type": "object", + "description": "The Private Endpoint Connection resource.", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Resource properties." + }, + "etag": { + "type": "string", + "description": "Resource Etag.", + "readOnly": true + }, + "location": { + "type": "string", + "description": "The location of the private endpoint connection" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "A list of private endpoint connections", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + } + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of the PrivateEndpointConnectProperties.", + "properties": { + "privateEndpoint": { + "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpoint", + "description": "The resource of private end point." + }, + "privateLinkServiceConnectionState": { + "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource.", + "readOnly": true + }, + "groupIds": { + "type": "array", + "description": "The private link resource group ids.", + "items": { + "type": "string" + } + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpointOutboundRule": { + "type": "object", + "description": "Private Endpoint outbound rule for the managed network of a cognitive services account.", + "properties": { + "destination": { + "$ref": "#/definitions/PrivateEndpointOutboundRuleDestination", + "description": "Private Endpoint destination." + }, + "fqdns": { + "type": "array", + "description": "List of FQDNs associated with the private endpoint outbound rule.", + "items": { + "type": "string" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/OutboundRule" + } + ], + "x-ms-discriminator-value": "PrivateEndpoint" + }, + "PrivateEndpointOutboundRuleDestination": { + "type": "object", + "description": "Private Endpoint destination for an outbound rule.", + "properties": { + "serviceResourceId": { + "type": "string", + "description": "The Azure resource ID of the target private endpoint service." + }, + "subresourceTarget": { + "type": "string", + "description": "The subresource of the target service to connect to." + } + } + }, + "PrivateLinkResource": { + "type": "object", + "description": "A private link resource", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ] + }, + "PrivateLinkResourceListResult": { + "type": "object", + "description": "A list of private link resources", + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + }, + "PrivateLinkResourceProperties": { + "type": "object", + "description": "Properties of a private link resource.", + "properties": { + "groupId": { + "type": "string", + "description": "The private link resource group id.", + "readOnly": true + }, + "requiredMembers": { + "type": "array", + "description": "The private link resource required member names.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "description": "The private link resource Private link DNS zone name.", + "items": { + "type": "string" + } + }, + "displayName": { + "type": "string", + "description": "The private link resource display name.", + "readOnly": true + } + } + }, + "Project": { + "type": "object", + "description": "Cognitive Services project is an Azure resource representing the provisioned account's project, it's type, location and SKU.", + "properties": { + "properties": { + "$ref": "#/definitions/ProjectProperties", + "description": "Properties of Cognitive Services project." + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "location": { + "type": "string", + "description": "The geo-location where the resource lives", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "etag": { + "type": "string", + "description": "Resource Etag.", + "readOnly": true + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "Identity for the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ProjectCapabilityHost": { + "type": "object", + "description": "Azure Resource Manager resource envelope for Project CapabilityHost.", + "properties": { + "properties": { + "$ref": "#/definitions/ProjectCapabilityHostProperties", + "description": "[Required] Additional attributes of the entity." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ProjectCapabilityHostProperties": { + "type": "object", + "properties": { + "aiServicesConnections": { + "type": "array", + "description": "List of AI services connections.", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "vectorStoreConnections": { + "type": "array", + "description": "List of connection names from those available in the account or project to be used for vector database (e.g. CosmosDB).", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "storageConnections": { + "type": "array", + "description": "List of connection names from those available in the account or project to be used as a storage resource.", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "threadStorageConnections": { + "type": "array", + "description": "List of connection names from those available in the account or project to be used for Thread storage.", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/CapabilityHostProvisioningState", + "description": "Provisioning state for the CapabilityHost.", + "readOnly": true + } + } + }, + "ProjectCapabilityHostResourceArmPaginatedResult": { + "type": "object", + "description": "A paginated list of Project Capability Host entities.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link to the next page of Project Capability Host objects. If null, there are no additional pages.", + "x-nullable": true + }, + "value": { + "type": "array", + "description": "An array of objects of type Project Capability Host.", + "items": { + "$ref": "#/definitions/ProjectCapabilityHost" + } + } + } + }, + "ProjectListResult": { + "type": "object", + "description": "The list of cognitive services projects operation response.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link used to get the next page of projects." + }, + "value": { + "type": "array", + "description": "Gets the list of Cognitive Services projects and their properties.", + "items": { + "$ref": "#/definitions/Project" + }, + "readOnly": true + } + } + }, + "ProjectProperties": { + "type": "object", + "description": "Properties of Cognitive Services Project'.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Gets the status of the cognitive services project at the time the operation was called.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The display name of the Cognitive Services Project." + }, + "description": { + "type": "string", + "description": "The description of the Cognitive Services Project." + }, + "endpoints": { + "type": "object", + "description": "The list of endpoint for this Cognitive Services Project.", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "isDefault": { + "type": "boolean", + "description": "Indicates whether the project is the default project for the account.", + "readOnly": true + } + } + }, + "ProviderInfo": { + "type": "object", + "description": "Service provider information for the Agent", + "properties": { + "organization": { + "type": "string", + "description": "Organization name of the provider.", + "x-nullable": true + }, + "url": { + "type": "string", + "description": "URL of the provider.", + "x-nullable": true + } + } + }, + "ProvisioningIssue": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the NSP provisioning issue" + }, + "properties": { + "$ref": "#/definitions/ProvisioningIssueProperties", + "description": "Properties of Provisioning Issue" + } + } + }, + "ProvisioningIssueProperties": { + "type": "object", + "description": "Properties of Provisioning Issue", + "properties": { + "issueType": { + "type": "string", + "description": "Type of Issue" + }, + "severity": { + "type": "string", + "description": "Severity of the issue" + }, + "description": { + "type": "string", + "description": "Description of the issue" + }, + "suggestedResourceIds": { + "type": "array", + "description": "IDs of resources that can be associated to the same perimeter to remediate the issue.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource." + } + }, + "suggestedAccessRules": { + "type": "array", + "description": "Optional array, suggested access rules", + "items": { + "$ref": "#/definitions/NetworkSecurityPerimeterAccessRule" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "Gets the status of the cognitive services account at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Deleting", + "Moving", + "Failed", + "Succeeded", + "Canceled", + "ResolvingDNS" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Accepted", + "value": "Accepted" + }, + { + "name": "Creating", + "value": "Creating" + }, + { + "name": "Deleting", + "value": "Deleting" + }, + { + "name": "Moving", + "value": "Moving" + }, + { + "name": "Failed", + "value": "Failed" + }, + { + "name": "Succeeded", + "value": "Succeeded" + }, + { + "name": "Canceled", + "value": "Canceled" + }, + { + "name": "ResolvingDNS", + "value": "ResolvingDNS" + } + ] + }, + "readOnly": true + }, + "PublicNetworkAccess": { + "type": "string", + "description": "Whether or not public endpoint access is allowed for this account.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled" + }, + { + "name": "Disabled", + "value": "Disabled" + } + ] + } + }, + "QuotaLimit": { + "type": "object", + "properties": { + "count": { + "type": "number", + "format": "float" + }, + "renewalPeriod": { + "type": "number", + "format": "float" + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/ThrottlingRule" + }, + "x-ms-identifiers": [ + "key" + ] + } + } + }, + "QuotaTier": { + "type": "object", + "description": "The quota tier information for the subscription", + "properties": { + "properties": { + "$ref": "#/definitions/QuotaTierProperties", + "description": "Properties of quota tier resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "QuotaTierListResult": { + "type": "object", + "description": "The list of Quota Tiers response.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link used to get the next page of quota tiers." + }, + "value": { + "type": "array", + "description": "Gets the list of Quota Tiers and their properties.", + "items": { + "$ref": "#/definitions/QuotaTier" + }, + "readOnly": true, + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "QuotaTierProperties": { + "type": "object", + "description": "Properties of Quota Tier resource'.", + "properties": { + "currentTierName": { + "type": "string", + "description": "Name of the current quota tier for the subscription.", + "readOnly": true + }, + "tierUpgradePolicy": { + "$ref": "#/definitions/TierUpgradePolicy", + "description": "Gets the tier upgrade policy for the subscription." + }, + "assignmentDate": { + "type": "string", + "format": "date-time", + "description": "The date on which the current tier was assigned to the subscription (UTC).", + "readOnly": true + }, + "tierUpgradeEligibilityInfo": { + "$ref": "#/definitions/QuotaTierUpgradeEligibilityInfo", + "description": "Information about the quota tier upgrade eligibility for the subscription.", + "x-nullable": true, + "readOnly": true + } + } + }, + "QuotaTierUpgradeEligibilityInfo": { + "type": "object", + "description": "Information about the quota tier upgrade eligibility for the subscription.", + "properties": { + "nextTierName": { + "type": "string", + "description": "Name of the next quota tier for the subscription.", + "x-nullable": true + }, + "upgradeAvailabilityStatus": { + "$ref": "#/definitions/UpgradeAvailabilityStatus", + "description": "Specifies whether an upgrade to the next quota tier is available." + }, + "upgradeApplicableDate": { + "type": "string", + "format": "date-time", + "description": "The date after which the current tier will be upgraded to the next tier if the TierUpgradePolicy is \"OnceUpgradeIsAvailable\" (UTC).", + "x-nullable": true + }, + "upgradeUnavailabilityReason": { + "type": "string", + "description": "Reason in case the subscription is not eligible for upgrade to the next tier.", + "x-nullable": true + } + } + }, + "QuotaUsageStatus": { + "type": "string", + "description": "Cognitive Services account quota usage status.", + "enum": [ + "Included", + "Blocked", + "InOverage", + "Unknown" + ], + "x-ms-enum": { + "name": "QuotaUsageStatus", + "modelAsString": true, + "values": [ + { + "name": "Included", + "value": "Included" + }, + { + "name": "Blocked", + "value": "Blocked" + }, + { + "name": "InOverage", + "value": "InOverage" + }, + { + "name": "Unknown", + "value": "Unknown" + } + ] + } + }, + "RaiActionType": { + "type": "string", + "description": "The action types to apply to the content filters", + "enum": [ + "None", + "BLOCKING", + "ANNOTATING", + "HITL", + "RETRY" + ], + "x-ms-enum": { + "name": "RaiActionType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None" + }, + { + "name": "BLOCKING", + "value": "BLOCKING" + }, + { + "name": "ANNOTATING", + "value": "ANNOTATING" + }, + { + "name": "HITL", + "value": "HITL" + }, + { + "name": "RETRY", + "value": "RETRY" + } + ] + } + }, + "RaiBlockListItemsResult": { + "type": "object", + "description": "The list of cognitive services RAI Blocklist Items.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link used to get the next page of RaiBlocklistItems." + }, + "value": { + "type": "array", + "description": "The list of RaiBlocklistItems.", + "items": { + "$ref": "#/definitions/RaiBlocklistItem" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "RaiBlockListResult": { + "type": "object", + "description": "The list of cognitive services RAI Blocklists.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link used to get the next page of RaiBlocklists." + }, + "value": { + "type": "array", + "description": "The list of RaiBlocklist.", + "items": { + "$ref": "#/definitions/RaiBlocklist" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "RaiBlocklist": { + "type": "object", + "description": "Cognitive Services RaiBlocklist.", + "properties": { + "properties": { + "$ref": "#/definitions/RaiBlocklistProperties", + "description": "Properties of Cognitive Services RaiBlocklist." + }, + "etag": { + "type": "string", + "description": "Resource Etag.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "RaiBlocklistConfig": { + "type": "object", + "description": "Azure OpenAI blocklist config.", + "properties": { + "blocklistName": { + "type": "string", + "description": "Name of ContentFilter." + }, + "blocking": { + "type": "boolean", + "description": "If blocking would occur." + } + } + }, + "RaiBlocklistItem": { + "type": "object", + "description": "Cognitive Services RaiBlocklist Item.", + "properties": { + "properties": { + "$ref": "#/definitions/RaiBlocklistItemProperties", + "description": "Properties of Cognitive Services RaiBlocklist Item." + }, + "etag": { + "type": "string", + "description": "Resource Etag.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "RaiBlocklistItemBulkRequest": { + "type": "object", + "description": "The Cognitive Services RaiBlocklist Item request body.", + "properties": { + "name": { + "type": "string" + }, + "properties": { + "$ref": "#/definitions/RaiBlocklistItemProperties", + "description": "Properties of Cognitive Services RaiBlocklist Item." + } + } + }, + "RaiBlocklistItemProperties": { + "type": "object", + "description": "RAI Custom Blocklist Item properties.", + "properties": { + "pattern": { + "type": "string", + "description": "Pattern to match against." + }, + "isRegex": { + "type": "boolean", + "description": "If the pattern is a regex pattern." + } + } + }, + "RaiBlocklistItemsBulkAddRequest": { + "type": "array", + "description": "The list of Cognitive Services RaiBlocklist Items for batch add.", + "items": { + "$ref": "#/definitions/RaiBlocklistItemBulkRequest" + } + }, + "RaiBlocklistItemsBulkDeleteRequest": { + "type": "array", + "description": "The list of Cognitive Services RaiBlocklist Items Names.", + "items": { + "type": "string" + } + }, + "RaiBlocklistProperties": { + "type": "object", + "description": "RAI Custom Blocklist properties.", + "properties": { + "description": { + "type": "string", + "description": "Description of the block list." + } + } + }, + "RaiContentFilter": { + "type": "object", + "description": "Azure OpenAI Content Filter.", + "properties": { + "properties": { + "$ref": "#/definitions/RaiContentFilterProperties", + "description": "Azure OpenAI Content Filter Properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "RaiContentFilterListResult": { + "type": "object", + "description": "The list of Content Filters.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link used to get the next page of Content Filters." + }, + "value": { + "type": "array", + "description": "The list of RaiContentFilter.", + "items": { + "$ref": "#/definitions/RaiContentFilter" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "RaiContentFilterProperties": { + "type": "object", + "description": "Azure OpenAI Content Filter Properties.", + "properties": { + "name": { + "type": "string", + "description": "Name of Content Filter." + }, + "isMultiLevelFilter": { + "type": "boolean", + "description": "If the Content Filter has multi severity levels(Low, Medium, or High)." + }, + "source": { + "$ref": "#/definitions/RaiPolicyContentSource", + "description": "Content source to apply the Content Filters." + } + } + }, + "RaiExternalSafetyProviderResult": { + "type": "object", + "description": "The list of cognitive services RAI External Safety Providers.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link used to get the next page of Rai External Safety Provider." + }, + "value": { + "type": "array", + "description": "The list of RaiExternalSafetyProvider.", + "items": { + "$ref": "#/definitions/RaiExternalSafetyProviderSchema" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "RaiExternalSafetyProviderSchema": { + "type": "object", + "description": "Cognitive Services Rai External Safety provider Schema.", + "properties": { + "properties": { + "$ref": "#/definitions/RaiExternalSafetyProviderSchemaProperties", + "description": "Properties of Cognitive Services Rai External Safety provider." + }, + "etag": { + "type": "string", + "description": "Resource Etag.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "RaiExternalSafetyProviderSchemaProperties": { + "type": "object", + "description": "RAI External SafetyProvider schema properties.", + "properties": { + "providerId": { + "type": "string", + "description": "The unique identifier of the safety provider." + }, + "providerName": { + "type": "string", + "description": "Name of the safety provider." + }, + "mode": { + "type": "string", + "description": "Safety provider mode sync/async." + }, + "url": { + "type": "string", + "format": "uri", + "description": "Webhook URL for the safety provider." + }, + "secretName": { + "type": "string", + "description": "The name of the secret in Key Vault that contains the api key to access the webhook." + }, + "managedIdentity": { + "type": "string", + "description": "The managed identity to access the Key Vault." + }, + "keyVaultUri": { + "type": "string", + "format": "uri", + "description": "The Key Vault URI that contains the api key for safety provider urls." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "Creation time of the safety provider.", + "readOnly": true + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "Last modified time of the safety provider.", + "readOnly": true + } + } + }, + "RaiMonitorConfig": { + "type": "object", + "description": "Cognitive Services Rai Monitor Config.", + "properties": { + "adxStorageResourceId": { + "type": "string", + "description": "The storage resource Id." + }, + "identityClientId": { + "type": "string", + "description": "The identity client Id to access the storage." + } + } + }, + "RaiPolicy": { + "type": "object", + "description": "Cognitive Services RaiPolicy.", + "properties": { + "properties": { + "$ref": "#/definitions/RaiPolicyProperties", + "description": "Properties of Cognitive Services RaiPolicy." + }, + "etag": { + "type": "string", + "description": "Resource Etag.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "RaiPolicyContentFilter": { + "type": "object", + "description": "Azure OpenAI Content Filter.", + "properties": { + "name": { + "type": "string", + "description": "Name of ContentFilter." + }, + "enabled": { + "type": "boolean", + "description": "If the ContentFilter is enabled." + }, + "severityThreshold": { + "$ref": "#/definitions/ContentLevel", + "description": "Level at which content is filtered." + }, + "blocking": { + "type": "boolean", + "description": "If blocking would occur." + }, + "source": { + "$ref": "#/definitions/RaiPolicyContentSource", + "description": "Content source to apply the Content Filters." + }, + "action": { + "$ref": "#/definitions/RaiActionType", + "description": "The action types to apply to the content filters" + } + } + }, + "RaiPolicyContentSource": { + "type": "string", + "description": "Content source to apply the Content Filters.", + "enum": [ + "Prompt", + "Completion", + "PreToolCall", + "PostToolCall", + "PreRun", + "PostRun" + ], + "x-ms-enum": { + "name": "RaiPolicyContentSource", + "modelAsString": true, + "values": [ + { + "name": "Prompt", + "value": "Prompt" + }, + { + "name": "Completion", + "value": "Completion" + }, + { + "name": "PreToolCall", + "value": "PreToolCall" + }, + { + "name": "PostToolCall", + "value": "PostToolCall" + }, + { + "name": "PreRun", + "value": "PreRun" + }, + { + "name": "PostRun", + "value": "PostRun" + } + ] + } + }, + "RaiPolicyListResult": { + "type": "object", + "description": "The list of cognitive services RaiPolicies.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link used to get the next page of RaiPolicy." + }, + "value": { + "type": "array", + "description": "The list of RaiPolicy.", + "items": { + "$ref": "#/definitions/RaiPolicy" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "RaiPolicyMode": { + "type": "string", + "description": "Rai policy mode. The enum value mapping is as below: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Please use 'Asynchronous_filter' after 2025-06-01. It is the same as 'Deferred' in previous version.", + "enum": [ + "Default", + "Deferred", + "Blocking", + "Asynchronous_filter" + ], + "x-ms-enum": { + "name": "RaiPolicyMode", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default" + }, + { + "name": "Deferred", + "value": "Deferred" + }, + { + "name": "Blocking", + "value": "Blocking" + }, + { + "name": "Asynchronous_filter", + "value": "Asynchronous_filter" + } + ] + } + }, + "RaiPolicyProperties": { + "type": "object", + "description": "Azure OpenAI Content Filters properties.", + "properties": { + "type": { + "$ref": "#/definitions/RaiPolicyType", + "description": "Content Filters policy type.", + "readOnly": true + }, + "mode": { + "$ref": "#/definitions/RaiPolicyMode", + "description": "Rai policy mode. The enum value mapping is as below: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Please use 'Asynchronous_filter' after 2025-06-01. It is the same as 'Deferred' in previous version." + }, + "basePolicyName": { + "type": "string", + "description": "Name of Rai policy." + }, + "contentFilters": { + "type": "array", + "description": "The list of Content Filters.", + "items": { + "$ref": "#/definitions/RaiPolicyContentFilter" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "customBlocklists": { + "type": "array", + "description": "The list of custom Blocklist.", + "items": { + "$ref": "#/definitions/CustomBlocklistConfig" + }, + "x-ms-identifiers": [] + }, + "safetyProviders": { + "type": "array", + "description": "The list of Safety Providers.", + "items": { + "$ref": "#/definitions/SafetyProviderConfig" + }, + "x-ms-identifiers": [] + } + } + }, + "RaiPolicyType": { + "type": "string", + "description": "Content Filters policy type.", + "enum": [ + "UserManaged", + "SystemManaged" + ], + "x-ms-enum": { + "name": "RaiPolicyType", + "modelAsString": true, + "values": [ + { + "name": "UserManaged", + "value": "UserManaged" + }, + { + "name": "SystemManaged", + "value": "SystemManaged" + } + ] + } + }, + "RaiSafetyProviderConfig": { + "type": "object", + "description": "Azure OpenAI RAI safety provider config.", + "properties": { + "safetyProviderName": { + "type": "string", + "description": "Name of RAI Safety Provider." + }, + "blocking": { + "type": "boolean", + "description": "If blocking would occur." + } + } + }, + "RaiToolLabel": { + "type": "object", + "description": "Cognitive Services RAI Tool Label resource.", + "properties": { + "properties": { + "$ref": "#/definitions/RaiToolLabelProperties", + "description": "Properties of the RAI Tool Label." + }, + "etag": { + "type": "string", + "description": "Resource Etag.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "RaiToolLabelProperties": { + "type": "object", + "description": "RAI Tool Label properties.", + "properties": { + "toolConnectionName": { + "type": "string", + "description": "The unique tool connection name, e.g., 'Web_Search'." + }, + "accountScope": { + "$ref": "#/definitions/RaiToolLabelPropertiesAccountScope", + "description": "Account-level tool label definition." + }, + "projectScopes": { + "type": "array", + "description": "List of project-level tool label definitions.", + "items": { + "$ref": "#/definitions/RaiToolLabelPropertiesProjectScopesItem" + } + } + }, + "required": [ + "toolConnectionName" + ] + }, + "RaiToolLabelPropertiesAccountScope": { + "type": "object", + "description": "Account-level tool label definition.", + "properties": { + "labelValues": { + "type": "object", + "description": "Dictionary of label key-value pairs for the account scope.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "RaiToolLabelPropertiesProjectScopesItem": { + "type": "object", + "properties": { + "project": { + "type": "string", + "description": "Project name to which this scope applies." + }, + "labelValues": { + "type": "object", + "description": "Dictionary of label key-value pairs for the project scope.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "project", + "labelValues" + ] + }, + "RaiToolLabelResult": { + "type": "object", + "description": "The list of Cognitive Services RAI Tool Labels.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link used to get the next page of RaiToolLabels." + }, + "value": { + "type": "array", + "description": "The list of RAI Tool Labels.", + "items": { + "$ref": "#/definitions/RaiToolLabel" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "RaiTopic": { + "type": "object", + "description": "Cognitive Services Rai Topic.", + "properties": { + "properties": { + "$ref": "#/definitions/RaiTopicProperties", + "description": "Properties of Cognitive Services Rai Topic." + }, + "etag": { + "type": "string", + "description": "Resource Etag.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "RaiTopicProperties": { + "type": "object", + "description": "RAI Custom Topic properties.", + "properties": { + "topicId": { + "type": "string", + "description": "The unique identifier of the custom topic." + }, + "topicName": { + "type": "string", + "description": "The name of the custom topic." + }, + "description": { + "type": "string", + "description": "Description of the custom topic." + }, + "sampleBlobUrl": { + "type": "string", + "description": "Sample blob url for the custom topic." + }, + "status": { + "type": "string", + "description": "Status of the custom topic." + }, + "failedReason": { + "type": "string", + "description": "Failed reason if the status is Failed." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "Creation time of the custom topic." + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "Last modified time of the custom topic." + } + } + }, + "RaiTopicResult": { + "type": "object", + "description": "The list of cognitive services RAI Topics.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link used to get the next page of RaiTopics." + }, + "value": { + "type": "array", + "description": "The list of RaiTopic.", + "items": { + "$ref": "#/definitions/RaiTopic" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "RegenerateKeyParameters": { + "type": "object", + "description": "Regenerate key parameters.", + "properties": { + "keyName": { + "$ref": "#/definitions/KeyName", + "description": "key name to generate (Key1|Key2)" + } + }, + "required": [ + "keyName" + ] + }, + "RegionSetting": { + "type": "object", + "description": "The call rate limit Cognitive Services account.", + "properties": { + "name": { + "type": "string", + "description": "Name of the region." + }, + "value": { + "type": "number", + "format": "float", + "description": "A value for priority or weighted routing methods." + }, + "customsubdomain": { + "type": "string", + "description": "Maps the region to the regional custom subdomain." + } + } + }, + "ReplacementConfig": { + "type": "object", + "description": "Configuration for model replacement.", + "properties": { + "targetModelName": { + "type": "string", + "description": "The name of the replacement model." + }, + "targetModelVersion": { + "type": "string", + "description": "The version of the replacement model." + }, + "autoUpgradeStartDate": { + "type": "string", + "format": "date-time", + "description": "The date when automatic upgrade should start. This applies to deployments with the OnceNewDefaultVersionAvailable upgrade option." + }, + "upgradeOnExpiryLeadTimeDays": { + "type": "integer", + "format": "int32", + "description": "The number of days before deprecation date to trigger upgrade. This applies to deployments with the OnceCurrentVersionExpired upgrade option." + } + } + }, + "RequestMatchPattern": { + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "method": { + "type": "string" + } + } + }, + "ResourceBase": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The asset description text.", + "x-nullable": true + }, + "tags": { + "type": "object", + "description": "Tag dictionary. Tags can be added, removed, and updated.", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + }, + "ResourceIdentityType": { + "type": "string", + "description": "The identity type.", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "ResourceSku": { + "type": "object", + "description": "Describes an available Cognitive Services SKU.", + "properties": { + "resourceType": { + "type": "string", + "description": "The type of resource the SKU applies to." + }, + "name": { + "type": "string", + "description": "The name of SKU." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of Cognitive Services account." + }, + "kind": { + "type": "string", + "description": "The Kind of resources that are supported in this SKU." + }, + "locations": { + "type": "array", + "description": "The set of locations that the SKU is available.", + "items": { + "type": "string" + } + }, + "restrictions": { + "type": "array", + "description": "The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.", + "items": { + "$ref": "#/definitions/ResourceSkuRestrictions" + }, + "x-ms-identifiers": [] + } + } + }, + "ResourceSkuListResult": { + "type": "object", + "description": "The Get Skus operation response.", + "properties": { + "value": { + "type": "array", + "description": "The ResourceSku items on this page", + "items": { + "$ref": "#/definitions/ResourceSku" + }, + "x-ms-identifiers": [ + "resourceType", + "name", + "kind" + ] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ResourceSkuRestrictionInfo": { + "type": "object", + "properties": { + "locations": { + "type": "array", + "description": "Locations where the SKU is restricted", + "items": { + "type": "string" + } + }, + "zones": { + "type": "array", + "description": "List of availability zones where the SKU is restricted.", + "items": { + "type": "string" + } + } + } + }, + "ResourceSkuRestrictions": { + "type": "object", + "description": "Describes restrictions of a SKU.", + "properties": { + "type": { + "$ref": "#/definitions/ResourceSkuRestrictionsType", + "description": "The type of restrictions." + }, + "values": { + "type": "array", + "description": "The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted.", + "items": { + "type": "string" + } + }, + "restrictionInfo": { + "$ref": "#/definitions/ResourceSkuRestrictionInfo", + "description": "The information about the restriction where the SKU cannot be used." + }, + "reasonCode": { + "$ref": "#/definitions/ResourceSkuRestrictionsReasonCode", + "description": "The reason for restriction." + } + } + }, + "ResourceSkuRestrictionsReasonCode": { + "type": "string", + "description": "The reason for restriction.", + "enum": [ + "QuotaId", + "NotAvailableForSubscription" + ], + "x-ms-enum": { + "name": "ResourceSkuRestrictionsReasonCode", + "modelAsString": true, + "values": [ + { + "name": "QuotaId", + "value": "QuotaId" + }, + { + "name": "NotAvailableForSubscription", + "value": "NotAvailableForSubscription" + } + ] + } + }, + "ResourceSkuRestrictionsType": { + "type": "string", + "description": "The type of restrictions.", + "enum": [ + "Location", + "Zone" + ], + "x-ms-enum": { + "name": "ResourceSkuRestrictionsType", + "modelAsString": false + } + }, + "RoleBasedBuiltInAuthorizationPolicy": { + "type": "object", + "description": "Built-in role-based authorization policy.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationAuthorizationPolicy" + } + ], + "x-ms-discriminator-value": "Default" + }, + "RoutingMethods": { + "type": "string", + "description": "Multiregion routing methods.", + "enum": [ + "Priority", + "Weighted", + "Performance" + ], + "x-ms-enum": { + "name": "RoutingMethods", + "modelAsString": true, + "values": [ + { + "name": "Priority", + "value": "Priority" + }, + { + "name": "Weighted", + "value": "Weighted" + }, + { + "name": "Performance", + "value": "Performance" + } + ] + } + }, + "RoutingMode": { + "type": "string", + "description": "The model-router routing mode that determines how requests are distributed across models.", + "enum": [ + "cost", + "balanced", + "quality" + ], + "x-ms-enum": { + "name": "RoutingMode", + "modelAsString": true, + "values": [ + { + "name": "Cost", + "value": "cost", + "description": "Route requests to minimize cost while meeting performance requirements." + }, + { + "name": "Balanced", + "value": "balanced", + "description": "Balance cost and quality when routing requests across models." + }, + { + "name": "Quality", + "value": "quality", + "description": "Route requests to maximize quality regardless of cost." + } + ] + } + }, + "RuleAction": { + "type": "string", + "description": "The action enum for a managed network outbound rule.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "RuleAction", + "modelAsString": true, + "values": [ + { + "name": "Allow", + "value": "Allow" + }, + { + "name": "Deny", + "value": "Deny" + } + ] + } + }, + "RuleCategory": { + "type": "string", + "description": "Category of a managed network Outbound Rule of a cognitive services account.", + "enum": [ + "Required", + "Recommended", + "UserDefined", + "Dependency" + ], + "x-ms-enum": { + "name": "RuleCategory", + "modelAsString": true, + "values": [ + { + "name": "Required", + "value": "Required" + }, + { + "name": "Recommended", + "value": "Recommended" + }, + { + "name": "UserDefined", + "value": "UserDefined" + }, + { + "name": "Dependency", + "value": "Dependency" + } + ] + } + }, + "RuleStatus": { + "type": "string", + "description": "Type of a managed network Outbound Rule of a cognitive services account.", + "enum": [ + "Inactive", + "Active", + "Provisioning", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "RuleStatus", + "modelAsString": true, + "values": [ + { + "name": "Inactive", + "value": "Inactive" + }, + { + "name": "Active", + "value": "Active" + }, + { + "name": "Provisioning", + "value": "Provisioning" + }, + { + "name": "Deleting", + "value": "Deleting" + }, + { + "name": "Failed", + "value": "Failed" + } + ] + } + }, + "RuleType": { + "type": "string", + "description": "Type of a managed network Outbound Rule of a cognitive services account.", + "enum": [ + "FQDN", + "PrivateEndpoint", + "ServiceTag" + ], + "x-ms-enum": { + "name": "RuleType", + "modelAsString": true, + "values": [ + { + "name": "FQDN", + "value": "FQDN" + }, + { + "name": "PrivateEndpoint", + "value": "PrivateEndpoint" + }, + { + "name": "ServiceTag", + "value": "ServiceTag" + } + ] + } + }, + "SASAuthTypeConnectionProperties": { + "type": "object", + "properties": { + "credentials": { + "$ref": "#/definitions/ConnectionSharedAccessSignature" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "x-ms-discriminator-value": "SAS" + }, + "SafetyProviderConfig": { + "type": "object", + "description": "Gets or sets the source to which safety providers applies.", + "properties": { + "source": { + "$ref": "#/definitions/RaiPolicyContentSource", + "description": "Content source to apply the Content Filters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/RaiSafetyProviderConfig" + } + ] + }, + "ScenarioType": { + "type": "string", + "description": "Specifies what features in AI Foundry network injection applies to. Currently only supports 'agent' for agent scenarios. 'none' means no network injection.", + "enum": [ + "none", + "agent" + ], + "x-ms-enum": { + "name": "ScenarioType", + "modelAsString": true, + "values": [ + { + "name": "none", + "value": "none" + }, + { + "name": "agent", + "value": "agent" + } + ] + } + }, + "ServicePrincipalAuthTypeConnectionProperties": { + "type": "object", + "properties": { + "credentials": { + "$ref": "#/definitions/ConnectionServicePrincipal" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "x-ms-discriminator-value": "ServicePrincipal" + }, + "ServiceTagOutboundRule": { + "type": "object", + "description": "Service Tag outbound rule for the managed network of a cognitive services account.", + "properties": { + "destination": { + "$ref": "#/definitions/ServiceTagOutboundRuleDestination", + "description": "Service Tag destination." + } + }, + "allOf": [ + { + "$ref": "#/definitions/OutboundRule" + } + ], + "x-ms-discriminator-value": "ServiceTag" + }, + "ServiceTagOutboundRuleDestination": { + "type": "object", + "description": "Service Tag destination for an outbound rule.", + "properties": { + "serviceTag": { + "type": "string", + "description": "Name of the Azure service tag to target." + }, + "protocol": { + "type": "string", + "description": "Network protocol used by the service tag rule." + }, + "portRanges": { + "type": "string", + "description": "Destination port ranges." + }, + "action": { + "$ref": "#/definitions/RuleAction", + "description": "The action for the service tag outbound rule." + }, + "addressPrefixes": { + "type": "array", + "description": "Optional address prefixes. If provided, the serviceTag property will be ignored.", + "items": { + "type": "string" + } + } + } + }, + "ServiceTier": { + "type": "string", + "description": "The service tier for the deployment. Determines the pricing and performance level for request processing. Use 'Default' for standard pricing or 'Priority' for higher-priority processing with premium pricing. Note: Pause operations are only supported on Standard, DataZoneStandard, and GlobalStandard SKUs.", + "enum": [ + "Default", + "Priority" + ], + "x-ms-enum": { + "name": "ServiceTier", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Default service tier meaning the request will be processed with the standard pricing and performance for the selected model." + }, + { + "name": "Priority", + "value": "Priority", + "description": "Priority service tier meaning the request will be processed with higher pricing and performance for the selected model." + } + ] + } + }, + "Skill": { + "type": "object", + "description": "Collection of capability units the Agent can perform", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the skill.", + "x-nullable": true + }, + "name": { + "type": "string", + "description": "Human-readable name for the skill.", + "x-nullable": true + }, + "description": { + "type": "string", + "description": "Skill description.", + "x-nullable": true + }, + "tags": { + "type": "array", + "description": "Tags describing the skill's capability category (e.g., 'cooking', 'customer support').", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "examples": { + "type": "array", + "description": "Example scenarios or prompts the skill can execute (e.g., 'I need a recipe for bread').", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "inputModes": { + "type": "array", + "description": "Input MIME types supported by the skill (if different from default).", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "outputModes": { + "type": "array", + "description": "Output MIME types supported by the skill (if different from default).", + "x-nullable": true, + "items": { + "type": "string" + } + } + } + }, + "Sku": { + "type": "object", + "description": "The resource model definition representing SKU", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU. Ex - P3. It is typically a letter+number code" + }, + "tier": { + "$ref": "#/definitions/SkuTier", + "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." + }, + "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" + ] + }, + "SkuAvailability": { + "type": "object", + "description": "SKU availability.", + "properties": { + "kind": { + "type": "string", + "description": "The kind (type) of cognitive service account." + }, + "type": { + "type": "string", + "description": "The Type of the resource." + }, + "skuName": { + "type": "string", + "description": "The name of SKU." + }, + "skuAvailable": { + "type": "boolean", + "description": "Indicates the given SKU is available or not." + }, + "reason": { + "type": "string", + "description": "Reason why the SKU is not available." + }, + "message": { + "type": "string", + "description": "Additional error message." + } + } + }, + "SkuAvailabilityListResult": { + "type": "object", + "description": "Check SKU availability result list.", + "properties": { + "value": { + "type": "array", + "description": "Check SKU availability result list.", + "items": { + "$ref": "#/definitions/SkuAvailability" + }, + "x-ms-identifiers": [ + "skuName", + "type", + "kind" + ] + } + } + }, + "SkuCapability": { + "type": "object", + "description": "SkuCapability indicates the capability of a certain feature.", + "properties": { + "name": { + "type": "string", + "description": "The name of the SkuCapability." + }, + "value": { + "type": "string", + "description": "The value of the SkuCapability." + } + } + }, + "SkuChangeInfo": { + "type": "object", + "description": "Sku change info of account.", + "properties": { + "countOfDowngrades": { + "type": "number", + "format": "float", + "description": "Gets the count of downgrades." + }, + "countOfUpgradesAfterDowngrades": { + "type": "number", + "format": "float", + "description": "Gets the count of upgrades after downgrades." + }, + "lastChangeDate": { + "type": "string", + "description": "Gets the last change date." + } + } + }, + "SkuResource": { + "type": "object", + "description": "Properties of Cognitive Services account resource sku resource properties.", + "properties": { + "resourceType": { + "type": "string", + "description": "The resource type name." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The resource model definition representing SKU" + }, + "capacity": { + "$ref": "#/definitions/CapacityConfig", + "description": "The capacity configuration." + } + } + }, + "SkuTier": { + "type": "string", + "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.", + "enum": [ + "Free", + "Basic", + "Standard", + "Premium", + "Enterprise" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true, + "values": [ + { + "name": "Free", + "value": "Free" + }, + { + "name": "Basic", + "value": "Basic" + }, + { + "name": "Standard", + "value": "Standard" + }, + { + "name": "Premium", + "value": "Premium" + }, + { + "name": "Enterprise", + "value": "Enterprise" + } + ] + } + }, + "ThrottlingRule": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "renewalPeriod": { + "type": "number", + "format": "float" + }, + "count": { + "type": "number", + "format": "float" + }, + "minCount": { + "type": "number", + "format": "float" + }, + "dynamicThrottlingEnabled": { + "type": "boolean" + }, + "matchPatterns": { + "type": "array", + "items": { + "$ref": "#/definitions/RequestMatchPattern" + }, + "x-ms-identifiers": [ + "path", + "method" + ] + } + } + }, + "TierUpgradePolicy": { + "type": "string", + "description": "Gets the tier upgrade policy for the subscription.", + "enum": [ + "OnceUpgradeIsAvailable", + "NoAutoUpgrade" + ], + "x-ms-enum": { + "name": "TierUpgradePolicy", + "modelAsString": true, + "values": [ + { + "name": "OnceUpgradeIsAvailable", + "value": "OnceUpgradeIsAvailable" + }, + { + "name": "NoAutoUpgrade", + "value": "NoAutoUpgrade" + } + ] + } + }, + "TrafficRoutingProtocol": { + "type": "string", + "description": "Traffic routing protocol, used to distribute an application's inbound traffic to its deployments.", + "enum": [ + "FixedRatio" + ], + "x-ms-enum": { + "name": "TrafficRoutingProtocol", + "modelAsString": true, + "values": [ + { + "name": "FixedRatio", + "value": "FixedRatio", + "description": "Percentage based routing" + } + ] + } + }, + "TrafficRoutingRule": { + "type": "object", + "description": "Represents a rule for routing traffic to a specific deployment.", + "properties": { + "ruleId": { + "type": "string", + "description": "The identifier of this traffic routing rule.", + "x-nullable": true + }, + "description": { + "type": "string", + "description": "A user-provided description for this traffic routing rule.", + "x-nullable": true + }, + "deploymentId": { + "type": "string", + "description": "The unique identifier of the deployment to which traffic is routed by this rule.", + "x-nullable": true + }, + "trafficPercentage": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the percentage of traffic allocated to this instance." + } + } + }, + "UnitType": { + "type": "string", + "description": "The unit of the metric.", + "enum": [ + "Count", + "Bytes", + "Seconds", + "Percent", + "CountPerSecond", + "BytesPerSecond", + "Milliseconds" + ], + "x-ms-enum": { + "name": "UnitType", + "modelAsString": true, + "values": [ + { + "name": "Count", + "value": "Count" + }, + { + "name": "Bytes", + "value": "Bytes" + }, + { + "name": "Seconds", + "value": "Seconds" + }, + { + "name": "Percent", + "value": "Percent" + }, + { + "name": "CountPerSecond", + "value": "CountPerSecond" + }, + { + "name": "BytesPerSecond", + "value": "BytesPerSecond" + }, + { + "name": "Milliseconds", + "value": "Milliseconds" + } + ] + } + }, + "UpgradeAvailabilityStatus": { + "type": "string", + "description": "Specifies whether an upgrade to the next quota tier is available.", + "enum": [ + "Available", + "NotAvailable" + ], + "x-ms-enum": { + "name": "UpgradeAvailabilityStatus", + "modelAsString": true, + "values": [ + { + "name": "Available", + "value": "Available" + }, + { + "name": "NotAvailable", + "value": "NotAvailable" + } + ] + } + }, + "Usage": { + "type": "object", + "description": "The usage data for a usage request.", + "properties": { + "unit": { + "$ref": "#/definitions/UnitType", + "description": "The unit of the metric." + }, + "name": { + "$ref": "#/definitions/MetricName", + "description": "The name information for the metric." + }, + "quotaPeriod": { + "type": "string", + "description": "The quota period used to summarize the usage values." + }, + "limit": { + "type": "number", + "format": "double", + "description": "Maximum value for this metric." + }, + "currentValue": { + "type": "number", + "format": "double", + "description": "Current value for this metric." + }, + "nextResetTime": { + "type": "string", + "description": "Next reset time for current quota." + }, + "status": { + "$ref": "#/definitions/QuotaUsageStatus", + "description": "Cognitive Services account quota usage status." + } + } + }, + "UsageListResult": { + "type": "object", + "description": "The response to a list usage request.", + "properties": { + "nextLink": { + "type": "string", + "description": "The link used to get the next page of Usages." + }, + "value": { + "type": "array", + "description": "The list of usages for Cognitive Service account.", + "items": { + "$ref": "#/definitions/Usage" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "UserAssignedIdentity": { + "type": "object", + "description": "User-assigned managed identity.", + "properties": { + "principalId": { + "type": "string", + "description": "Azure Active Directory principal ID associated with this Identity.", + "readOnly": true + }, + "clientId": { + "type": "string", + "description": "Client App Id associated with this identity.", + "readOnly": true + } + } + }, + "UserOwnedAmlWorkspace": { + "type": "object", + "description": "The user owned AML account for Cognitive Services account.", + "properties": { + "resourceId": { + "type": "string", + "description": "Full resource id of a AML account resource." + }, + "identityClientId": { + "type": "string", + "description": "Identity Client id of a AML account resource." + } + } + }, + "UserOwnedStorage": { + "type": "object", + "description": "The user owned storage for Cognitive Services account.", + "properties": { + "resourceId": { + "type": "string", + "description": "Full resource id of a Microsoft.Storage resource." + }, + "identityClientId": { + "type": "string" + } + } + }, + "UsernamePasswordAuthTypeConnectionProperties": { + "type": "object", + "properties": { + "credentials": { + "$ref": "#/definitions/ConnectionUsernamePassword" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ConnectionPropertiesV2" + } + ], + "x-ms-discriminator-value": "UsernamePassword" + }, + "VersionedAgentReference": { + "type": "object", + "description": "Type modeling a reference to a version of an agent definition.", + "properties": { + "agentVersion": { + "type": "string", + "description": "Gets the agent's version (unique for each agent lineage).", + "x-nullable": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AgentReferenceProperties" + } + ] + }, + "VirtualNetworkRule": { + "type": "object", + "description": "A rule governing the accessibility from a specific virtual network.", + "properties": { + "id": { + "type": "string", + "description": "Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'." + }, + "state": { + "type": "string", + "description": "Gets the state of virtual network rule." + }, + "ignoreMissingVnetServiceEndpoint": { + "type": "boolean", + "description": "Ignore missing vnet service endpoint or not." + } + }, + "required": [ + "id" + ] + } + }, + "parameters": {} +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountCapabilityHost/createOrUpdate.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountCapabilityHost/createOrUpdate.json new file mode 100644 index 000000000000..b16735b73784 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountCapabilityHost/createOrUpdate.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "capabilityHost": { + "properties": { + "customerSubnet": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet", + "enablePublicHostingEnvironment": true + } + }, + "capabilityHostName": "capabilityHostName", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "capabilityHostName", + "type": "Microsoft.CognitiveServices/accounts/capabilityHosts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/account-1/capabilityHosts/capabilityHostName", + "properties": { + "description": "string", + "customerSubnet": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubne", + "enablePublicHostingEnvironment": true, + "provisioningState": "Succeeded", + "tags": { + "string": "string" + } + } + }, + "headers": {} + }, + "201": { + "body": { + "name": "capabilityHostName", + "type": "Microsoft.CognitiveServices/accounts/capabilityHosts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/account-1/capabilityHosts/capabilityHostName", + "properties": { + "description": "string", + "customerSubnet": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubne", + "enablePublicHostingEnvironment": true, + "provisioningState": "Succeeded", + "tags": { + "string": "string" + } + } + }, + "headers": { + "Location": "example_location" + } + } + }, + "operationId": "AccountCapabilityHosts_CreateOrUpdate", + "title": "CreateOrUpdate Account CapabilityHost." +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountCapabilityHost/delete.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountCapabilityHost/delete.json new file mode 100644 index 000000000000..5133eb0a267c --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountCapabilityHost/delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "AccountCapabilityHosts_Delete", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "capabilityHostName": "capabilityHostName", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Delete Account CapabilityHost.", + "responses": { + "202": { + "headers": { + "Location": "location_header_to_poll" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountCapabilityHost/get.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountCapabilityHost/get.json new file mode 100644 index 000000000000..ea2aca6bcb02 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountCapabilityHost/get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "capabilityHostName": "capabilityHostName", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "capabilityHostName", + "type": "Microsoft.CognitiveServices/accounts/capabilityHosts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/account-1/capabilityHosts/capabilityHostName", + "properties": { + "description": "string", + "customerSubnet": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubne", + "enablePublicHostingEnvironment": true, + "provisioningState": "Succeeded", + "tags": { + "string": "string" + } + } + }, + "headers": {} + } + }, + "operationId": "AccountCapabilityHosts_Get", + "title": "Get Account CapabilityHost." +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountCapabilityHost/list.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountCapabilityHost/list.json new file mode 100644 index 000000000000..1443852661a3 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountCapabilityHost/list.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "capabilityHostName", + "type": "Microsoft.CognitiveServices/accounts/capabilityHosts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/account-1/capabilityHosts/capabilityHostName", + "properties": { + "description": "string", + "customerSubnet": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubne", + "provisioningState": "Succeeded", + "tags": { + "string": "string" + } + } + } + ] + }, + "headers": {} + } + }, + "operationId": "AccountCapabilityHosts_List", + "title": "List Account CapabilityHosts." +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountConnection/create.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountConnection/create.json new file mode 100644 index 000000000000..5d5595d0d326 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountConnection/create.json @@ -0,0 +1,34 @@ +{ + "operationId": "AccountConnections_Create", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "connection": { + "properties": { + "authType": "None", + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[target url]" + } + }, + "connectionName": "connection-1", + "resourceGroupName": "resourceGroup-1", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "CreateAccountConnection", + "responses": { + "200": { + "body": { + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/connections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/connections/connection-1", + "properties": { + "authType": "None", + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[target url]" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountConnection/delete.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountConnection/delete.json new file mode 100644 index 000000000000..7152fbb453d2 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountConnection/delete.json @@ -0,0 +1,15 @@ +{ + "operationId": "AccountConnections_Delete", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "connectionName": "connection-1", + "resourceGroupName": "resourceGroup-1", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "DeleteAccountConnection", + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountConnection/get.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountConnection/get.json new file mode 100644 index 000000000000..6f86615bf029 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountConnection/get.json @@ -0,0 +1,26 @@ +{ + "operationId": "AccountConnections_Get", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "connectionName": "connection-1", + "resourceGroupName": "resourceGroup-1", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "GetAccountConnection", + "responses": { + "200": { + "body": { + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/connections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/connections/connection-1", + "properties": { + "authType": "None", + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[target url]" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountConnection/list.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountConnection/list.json new file mode 100644 index 000000000000..24d357cd8e4a --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountConnection/list.json @@ -0,0 +1,41 @@ +{ + "operationId": "AccountConnections_List", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "category": "ContainerRegistry", + "resourceGroupName": "resourceGroup-1", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "target": "[target url]" + }, + "title": "ListAccountConnections", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/connections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/connections/connection-1", + "properties": { + "authType": "PAT", + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[target url]" + } + }, + { + "name": "connection-2", + "type": "Microsoft.CognitiveServices/accounts/connections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/connections/connection-2", + "properties": { + "authType": "PAT", + "category": "ContainerRegistry", + "target": "[target url]" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountConnection/update.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountConnection/update.json new file mode 100644 index 000000000000..e6227bf190d2 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AccountConnection/update.json @@ -0,0 +1,41 @@ +{ + "operationId": "AccountConnections_Update", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "connection": { + "properties": { + "authType": "AccessKey", + "category": "ADLSGen2", + "credentials": { + "accessKeyId": "some_string", + "secretAccessKey": "some_string" + }, + "expiryTime": "2020-01-01T00:00:00Z", + "metadata": {}, + "target": "some_string" + } + }, + "connectionName": "connection-1", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "UpdateAccountConnection", + "responses": { + "200": { + "body": { + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/connections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/connections/connection-1", + "properties": { + "authType": "AccessKey", + "category": "ADLSGen2", + "expiryTime": "2020-01-01T00:00:00Z", + "metadata": {}, + "target": "some_string" + } + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AddRaiBlocklistItems.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AddRaiBlocklistItems.json new file mode 100644 index 000000000000..25dff060eb93 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AddRaiBlocklistItems.json @@ -0,0 +1,38 @@ +{ + "operationId": "RaiBlocklistItems_BatchAdd", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiBlocklistItems": [ + { + "name": "myblocklistitem1", + "properties": { + "isRegex": true, + "pattern": "^[a-z0-9_-]{2,16}$" + } + }, + { + "name": "myblocklistitem2", + "properties": { + "isRegex": false, + "pattern": "blockwords" + } + } + ], + "raiBlocklistName": "myblocklist", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "AddRaiBlocklistItems", + "responses": { + "200": { + "body": { + "name": "myblocklist", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "description": "Brief description of the blocklist" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/createOrUpdate.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/createOrUpdate.json new file mode 100644 index 000000000000..a12c22851276 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/createOrUpdate.json @@ -0,0 +1,74 @@ +{ + "operationId": "AgentApplications_CreateOrUpdate", + "parameters": { + "name": "agent-app-1", + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "body": { + "properties": { + "description": "Sample agent application for customer support", + "displayName": "Customer Support Agent", + "tags": { + "environment": "production", + "team": "ai-platform" + } + } + }, + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Create or Update Account Agent Application.", + "responses": { + "200": { + "body": { + "name": "agent-app-1", + "type": "Microsoft.CognitiveServices/accounts/projects/applications", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1", + "properties": { + "description": "Sample agent application for customer support", + "displayName": "Customer Support Agent", + "provisioningState": "Succeeded", + "tags": { + "environment": "production", + "team": "ai-platform" + } + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + }, + "headers": {} + }, + "201": { + "body": { + "name": "agent-app-1", + "type": "Microsoft.CognitiveServices/accounts/projects/applications", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1", + "properties": { + "description": "Sample agent application for customer support", + "displayName": "Customer Support Agent", + "provisioningState": "Creating", + "tags": { + "environment": "production", + "team": "ai-platform" + } + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/delete.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/delete.json new file mode 100644 index 000000000000..e37bdb6c5e69 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/delete.json @@ -0,0 +1,21 @@ +{ + "operationId": "AgentApplications_Delete", + "parameters": { + "name": "agent-app-1", + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Delete Account Agent Application.", + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.CognitiveServices/locations/westus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2026-05-01", + "Retry-After": "10" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/disable.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/disable.json new file mode 100644 index 000000000000..397b8338d452 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/disable.json @@ -0,0 +1,15 @@ +{ + "operationId": "AgentApplications_Disable", + "parameters": { + "name": "agent-app-1", + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Disable Agent Application.", + "responses": { + "200": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/enable.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/enable.json new file mode 100644 index 000000000000..4b738572fa9c --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/enable.json @@ -0,0 +1,15 @@ +{ + "operationId": "AgentApplications_Enable", + "parameters": { + "name": "agent-app-1", + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Enable Agent Application.", + "responses": { + "200": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/get.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/get.json new file mode 100644 index 000000000000..fb5fd8e67dda --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/get.json @@ -0,0 +1,38 @@ +{ + "operationId": "AgentApplications_Get", + "parameters": { + "name": "agent-app-1", + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Get Account Agent Application.", + "responses": { + "200": { + "body": { + "name": "agent-app-1", + "type": "Microsoft.CognitiveServices/accounts/projects/applications", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1", + "properties": { + "description": "Sample agent application for customer support", + "displayName": "Customer Support Agent", + "tags": { + "environment": "production", + "team": "ai-platform" + } + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/list.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/list.json new file mode 100644 index 000000000000..5de4b0578dbe --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/list.json @@ -0,0 +1,51 @@ +{ + "operationId": "AgentApplications_List", + "parameters": { + "$skipToken": "string", + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "count": 30, + "names": [ + "agent-app-1", + "agent-app-2" + ], + "orderBy": "name", + "orderByAsc": true, + "projectName": "my-project", + "resourceGroupName": "test-rg", + "searchText": "test", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List Account Agent Applications.", + "responses": { + "200": { + "body": { + "nextLink": "string", + "value": [ + { + "name": "agent-app-1", + "type": "Microsoft.CognitiveServices/accounts/projects/applications", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1", + "properties": { + "description": "Sample agent application for customer support", + "displayName": "Customer Support Agent", + "tags": { + "environment": "production", + "team": "ai-platform" + } + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + } + ] + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/listAgents.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/listAgents.json new file mode 100644 index 000000000000..fe6586c5be07 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentApplication/listAgents.json @@ -0,0 +1,56 @@ +{ + "operationId": "AgentApplications_ListAgents", + "parameters": { + "name": "agent-app-1", + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List Agents for Agent Application.", + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "name": "CustomerSupportAgent", + "type": "Microsoft.CognitiveServices/accounts/projects/applications/agents", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/agents/agent-001", + "properties": { + "agentId": "agent-001", + "agentName": "CustomerSupportAgent" + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + }, + { + "name": "TechnicalSupportAgent", + "type": "Microsoft.CognitiveServices/accounts/projects/applications/agents", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/agents/agent-002", + "properties": { + "agentId": "agent-002", + "agentName": "TechnicalSupportAgent" + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + } + ] + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/createOrUpdate.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/createOrUpdate.json new file mode 100644 index 000000000000..183cb12050db --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/createOrUpdate.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "appName": "agent-app-1", + "body": { + "properties": { + "agents": [ + { + "agentId": "agent-123", + "agentName": "support-agent", + "agentVersion": "1.0.0" + } + ], + "deploymentType": "Managed", + "displayName": "Production Deployment", + "protocols": [ + { + "version": "1.0", + "protocol": "Agent" + } + ], + "state": "Starting" + } + }, + "deploymentName": "deployment-1", + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "deployment-1", + "type": "Microsoft.CognitiveServices/accounts/projects/applications/agentDeployments", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/agentDeployments/deployment-1", + "properties": { + "agents": [ + { + "agentId": "agent-123", + "agentName": "support-agent", + "agentVersion": "1.0.0" + } + ], + "deploymentId": "550e8400-e29b-41d4-a716-446655440001", + "deploymentType": "Managed", + "displayName": "Production Deployment", + "protocols": [ + { + "version": "1.0", + "protocol": "Agent" + } + ], + "provisioningState": "Succeeded", + "state": "Running" + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + }, + "headers": {} + }, + "201": { + "body": { + "name": "deployment-1", + "type": "Microsoft.CognitiveServices/accounts/projects/applications/agentDeployments", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/agentDeployments/deployment-1", + "properties": { + "agents": [ + { + "agentId": "agent-123", + "agentName": "support-agent", + "agentVersion": "1.0.0" + } + ], + "deploymentId": "550e8400-e29b-41d4-a716-446655440001", + "deploymentType": "Managed", + "displayName": "Production Deployment", + "protocols": [ + { + "version": "1.0", + "protocol": "Agent" + } + ], + "provisioningState": "Creating", + "state": "Starting" + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.CognitiveServices/locations/westus/operationresults/00000000-1111-2222-3333-444444444444?api-version=2026-05-01" + } + } + }, + "operationId": "AgentDeployments_CreateOrUpdate", + "title": "Create or Update Agent Deployment." +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/delete.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/delete.json new file mode 100644 index 000000000000..151416b9c7b6 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/delete.json @@ -0,0 +1,22 @@ +{ + "operationId": "AgentDeployments_Delete", + "parameters": { + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "appName": "agent-app-1", + "deploymentName": "deployment-1", + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Delete Agent Deployment.", + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.CognitiveServices/locations/westus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2026-05-01", + "Retry-After": "10" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/get.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/get.json new file mode 100644 index 000000000000..34f170045931 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/get.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "appName": "agent-app-1", + "deploymentName": "deployment-1", + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "deployment-1", + "type": "Microsoft.CognitiveServices/accounts/projects/applications/agentDeployments", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/agentDeployments/deployment-1", + "properties": { + "agents": [ + { + "agentId": "agent-123", + "agentName": "support-agent", + "agentVersion": "1.0.0" + } + ], + "deploymentId": "550e8400-e29b-41d4-a716-446655440001", + "deploymentType": "Managed", + "displayName": "Production Deployment", + "protocols": [ + { + "version": "1.0", + "protocol": "Agent" + } + ], + "provisioningState": "Succeeded", + "state": "Running" + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + }, + "headers": {} + } + }, + "operationId": "AgentDeployments_Get", + "title": "Get Agent Deployment." +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/list.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/list.json new file mode 100644 index 000000000000..68bc73a6d879 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/list.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "appName": "agent-app-1", + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "deployment-1", + "type": "Microsoft.CognitiveServices/accounts/projects/applications/agentDeployments", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/agentDeployments/deployment-1", + "properties": { + "agents": [ + { + "agentId": "agent-123", + "agentName": "support-agent", + "agentVersion": "1.0.0" + } + ], + "deploymentId": "550e8400-e29b-41d4-a716-446655440001", + "deploymentType": "Managed", + "displayName": "Production Deployment", + "protocols": [ + { + "version": "1.0", + "protocol": "Agent" + } + ], + "provisioningState": "Succeeded", + "state": "Running" + }, + "systemData": { + "createdAt": "2024-09-29T12:34:56.999Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2024-09-29T12:34:56.999Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + } + } + ] + }, + "headers": {} + } + }, + "operationId": "AgentDeployments_List", + "title": "List Agent Deployments." +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/start.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/start.json new file mode 100644 index 000000000000..36b350f0d289 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/start.json @@ -0,0 +1,16 @@ +{ + "operationId": "AgentDeployments_Start", + "parameters": { + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "appName": "agent-app-1", + "deploymentName": "deployment-1", + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Start Agent Deployment.", + "responses": { + "200": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/stop.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/stop.json new file mode 100644 index 000000000000..5d470de04d2d --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/AgentDeployment/stop.json @@ -0,0 +1,16 @@ +{ + "operationId": "AgentDeployments_Stop", + "parameters": { + "accountName": "my-cognitive-services-account", + "api-version": "2026-05-01", + "appName": "agent-app-1", + "deploymentName": "deployment-1", + "projectName": "my-project", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Stop Agent Deployment.", + "responses": { + "200": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CalculateModelCapacity.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CalculateModelCapacity.json new file mode 100644 index 000000000000..a5b864237fed --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CalculateModelCapacity.json @@ -0,0 +1,48 @@ +{ + "operationId": "calculateModelCapacity", + "parameters": { + "api-version": "2026-05-01", + "parameters": { + "model": { + "name": "gpt-4", + "format": "OpenAI", + "version": "0613" + }, + "skuName": "ProvisionedManaged", + "workloads": [ + { + "requestParameters": { + "avgGeneratedTokens": 50, + "avgPromptTokens": 30 + }, + "requestPerMinute": 10 + }, + { + "requestParameters": { + "avgGeneratedTokens": 20, + "avgPromptTokens": 60 + }, + "requestPerMinute": 20 + } + ] + }, + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Calculate Model Capacity", + "responses": { + "200": { + "body": { + "estimatedCapacity": { + "deployableValue": 400, + "value": 346 + }, + "model": { + "name": "gpt-4", + "format": "OpenAI", + "version": "0613" + }, + "skuName": "ProvisionedManaged" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CheckDomainAvailability.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CheckDomainAvailability.json new file mode 100644 index 000000000000..46355a107efa --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CheckDomainAvailability.json @@ -0,0 +1,23 @@ +{ + "operationId": "CheckDomainAvailability", + "parameters": { + "api-version": "2026-05-01", + "location": "westus", + "parameters": { + "type": "Microsoft.CognitiveServices/accounts", + "subdomainName": "contosodemoapp1" + }, + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Check SKU Availability", + "responses": { + "200": { + "body": { + "type": "Microsoft.CognitiveServices/accounts", + "isSubdomainAvailable": false, + "reason": "Sub domain name 'contosodemoapp1' is not valid", + "subdomainName": "contosodemoapp1" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CheckSkuAvailability.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CheckSkuAvailability.json new file mode 100644 index 000000000000..8eaf96a07b79 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CheckSkuAvailability.json @@ -0,0 +1,30 @@ +{ + "operationId": "CheckSkuAvailability", + "parameters": { + "api-version": "2026-05-01", + "location": "westus", + "parameters": { + "type": "Microsoft.CognitiveServices/accounts", + "kind": "Face", + "skus": [ + "S0" + ] + }, + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Check SKU Availability", + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.CognitiveServices/accounts", + "kind": "Face", + "skuAvailable": true, + "skuName": "S0" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateAccount.json new file mode 100644 index 000000000000..f4f6ca5af59a --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateAccount.json @@ -0,0 +1,142 @@ +{ + "operationId": "Accounts_Create", + "parameters": { + "account": { + "identity": { + "type": "SystemAssigned" + }, + "kind": "Emotion", + "location": "West US", + "properties": { + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "KeyName", + "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/", + "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA" + } + }, + "userOwnedStorage": [ + { + "resourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount" + } + ] + }, + "sku": { + "name": "S0" + } + }, + "accountName": "testCreate1", + "api-version": "2026-05-01", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Create Account", + "responses": { + "200": { + "body": { + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "Emotion", + "location": "West US", + "properties": { + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "FakeKeyName", + "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/", + "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA" + } + }, + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded", + "userOwnedStorage": [ + { + "resourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount" + } + ] + }, + "sku": { + "name": "S0" + } + } + }, + "201": { + "body": { + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "Emotion", + "location": "West US", + "properties": { + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "FakeKeyName", + "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/", + "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA" + } + }, + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded", + "userOwnedStorage": [ + { + "resourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount" + } + ] + }, + "sku": { + "name": "S0" + } + } + }, + "202": { + "body": { + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "Emotion", + "location": "West US", + "properties": { + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyName": "FakeKeyName", + "keyVaultUri": "https://pltfrmscrts-use-pc-dev.vault.azure.net/", + "keyVersion": "891CF236-D241-4738-9462-D506AF493DFA" + } + }, + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded", + "userOwnedStorage": [ + { + "resourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount" + } + ] + }, + "sku": { + "name": "S0" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateAccountMin.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateAccountMin.json new file mode 100644 index 000000000000..5baf9f41608f --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateAccountMin.json @@ -0,0 +1,89 @@ +{ + "operationId": "Accounts_Create", + "parameters": { + "account": { + "identity": { + "type": "SystemAssigned" + }, + "kind": "CognitiveServices", + "location": "West US", + "properties": {}, + "sku": { + "name": "S0" + } + }, + "accountName": "testCreate1", + "api-version": "2026-05-01", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Create Account Min", + "responses": { + "200": { + "body": { + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "Emotion", + "location": "West US", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + } + }, + "201": { + "body": { + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "Emotion", + "location": "West US", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + } + }, + "202": { + "body": { + "name": "testCreate1", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "Emotion", + "location": "West US", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateOrUpdateQuotaTier.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateOrUpdateQuotaTier.json new file mode 100644 index 000000000000..fcb23177b869 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateOrUpdateQuotaTier.json @@ -0,0 +1,40 @@ +{ + "operationId": "QuotaTiers_CreateOrUpdate", + "parameters": { + "default": "default", + "api-version": "2026-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tier": { + "properties": { + "tierUpgradePolicy": "NoAutoUpgrade" + } + } + }, + "title": "Update the quota tier resource for a subscription", + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.CognitiveServices/quotaTiers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/quotaTiers/default", + "properties": { + "assignmentDate": "2025-06-09T18:13:29.389Z", + "currentTierName": "Free-Tier", + "tierUpgradePolicy": "NoAutoUpgrade" + } + } + }, + "201": { + "body": { + "name": "default", + "type": "Microsoft.CognitiveServices/quotaTiers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/quotaTiers/default", + "properties": { + "assignmentDate": "2025-06-09T18:13:29.389Z", + "currentTierName": "Free-Tier", + "tierUpgradePolicy": "NoAutoUpgrade" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateProject.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateProject.json new file mode 100644 index 000000000000..d0b3451357af --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateProject.json @@ -0,0 +1,98 @@ +{ + "operationId": "Projects_Create", + "parameters": { + "accountName": "testCreate1", + "api-version": "2026-05-01", + "project": { + "identity": { + "type": "SystemAssigned" + }, + "location": "West US", + "properties": { + "description": "Description of this project", + "displayName": "p1" + } + }, + "projectName": "testProject1", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Create Project", + "responses": { + "200": { + "body": { + "name": "testProject1", + "type": "Microsoft.CognitiveServices/accounts/projects", + "etag": "W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1/projects/testProject1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "location": "West US", + "properties": { + "description": "Description of this project", + "displayName": "p1", + "endpoints": { + "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/" + }, + "isDefault": true, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "testProject1", + "type": "Microsoft.CognitiveServices/accounts/projects", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1/projects/testProject1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "location": "West US", + "properties": { + "description": "Description of this project", + "displayName": "p1", + "endpoints": { + "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/" + }, + "isDefault": true, + "provisioningState": "Succeeded" + } + } + }, + "202": { + "body": { + "name": "testProject1", + "type": "Microsoft.CognitiveServices/accounts/projects", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1/projects/testProject1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "location": "West US", + "properties": { + "description": "Description of this project", + "displayName": "p1", + "endpoints": { + "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/" + }, + "isDefault": true, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateProjectMin.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateProjectMin.json new file mode 100644 index 000000000000..0a6d6b19e897 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateProjectMin.json @@ -0,0 +1,89 @@ +{ + "operationId": "Projects_Create", + "parameters": { + "accountName": "testCreate1", + "api-version": "2026-05-01", + "project": { + "identity": { + "type": "SystemAssigned" + }, + "location": "West US", + "properties": {} + }, + "projectName": "testProject1", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Create Project Min", + "responses": { + "200": { + "body": { + "name": "testProject1", + "type": "Microsoft.CognitiveServices/accounts/projects", + "etag": "W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1/projects/testProject1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "location": "West US", + "properties": { + "endpoints": { + "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/" + }, + "isDefault": true, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "testProject1", + "type": "Microsoft.CognitiveServices/accounts/projects", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1/projects/testProject1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "location": "West US", + "properties": { + "endpoints": { + "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/" + }, + "isDefault": true, + "provisioningState": "Succeeded" + } + } + }, + "202": { + "body": { + "name": "testProject1", + "type": "Microsoft.CognitiveServices/accounts/projects", + "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1/projects/testProject1", + "identity": { + "type": "SystemAssigned", + "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "location": "West US", + "properties": { + "endpoints": { + "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/", + "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/" + }, + "isDefault": true, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateSharedCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateSharedCommitmentPlan.json new file mode 100644 index 000000000000..7e8f3323cfe3 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateSharedCommitmentPlan.json @@ -0,0 +1,69 @@ +{ + "operationId": "CommitmentPlans_CreateOrUpdatePlan", + "parameters": { + "api-version": "2026-05-01", + "commitmentPlan": { + "kind": "SpeechServices", + "location": "West US", + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "STT" + }, + "sku": { + "name": "S0" + } + }, + "commitmentPlanName": "commitmentPlanName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Create Commitment Plan", + "responses": { + "200": { + "body": { + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "kind": "SpeechServices", + "location": "West US", + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "STT", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + } + }, + "201": { + "body": { + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "kind": "SpeechServices", + "location": "West US", + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "STT", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateSharedCommitmentPlanAssociation.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateSharedCommitmentPlanAssociation.json new file mode 100644 index 000000000000..2a53f8eb116c --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/CreateSharedCommitmentPlanAssociation.json @@ -0,0 +1,38 @@ +{ + "operationId": "CommitmentPlans_CreateOrUpdateAssociation", + "parameters": { + "api-version": "2026-05-01", + "association": { + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + }, + "commitmentPlanAssociationName": "commitmentPlanAssociationName", + "commitmentPlanName": "commitmentPlanName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "PutCommitmentPlan", + "responses": { + "200": { + "body": { + "name": "commitmentPlanAssociationName", + "type": "Microsoft.CognitiveServices/commitmentPlans/accountAssociations", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName/accountAssociations/commitmentPlanAssociationName", + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + } + }, + "201": { + "body": { + "name": "commitmentPlanAssociationName", + "type": "Microsoft.CognitiveServices/commitmentPlans/accountAssociations", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName/accountAssociations/commitmentPlanAssociationName", + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteAccount.json new file mode 100644 index 000000000000..68e8a8cc47d9 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteAccount.json @@ -0,0 +1,19 @@ +{ + "operationId": "Accounts_Delete", + "parameters": { + "accountName": "PropTest01", + "api-version": "2026-05-01", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Delete Account", + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteCommitmentPlan.json new file mode 100644 index 000000000000..503e1e964add --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteCommitmentPlan.json @@ -0,0 +1,20 @@ +{ + "operationId": "CommitmentPlans_Delete", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "commitmentPlanName": "commitmentPlanName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "DeleteCommitmentPlan", + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteDeployment.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteDeployment.json new file mode 100644 index 000000000000..dbf43910032e --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteDeployment.json @@ -0,0 +1,20 @@ +{ + "operationId": "Deployments_Delete", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "deploymentName": "deploymentName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "DeleteDeployment", + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteEncryptionScope.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteEncryptionScope.json new file mode 100644 index 000000000000..cac0afef39b3 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteEncryptionScope.json @@ -0,0 +1,19 @@ +{ + "operationId": "EncryptionScopes_Delete", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "encryptionScopeName": "encryptionScopeName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "DeleteEncryptionScope", + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeletePrivateEndpointConnection.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..d4c986d4f85a --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeletePrivateEndpointConnection.json @@ -0,0 +1,21 @@ +{ + "operationId": "PrivateEndpointConnections_Delete", + "parameters": { + "accountName": "sto2527", + "api-version": "2026-05-01", + "monitor": "true", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "resourceGroupName": "res6977", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "DeletePrivateEndpointConnection", + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteProject.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteProject.json new file mode 100644 index 000000000000..a1355969120a --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteProject.json @@ -0,0 +1,20 @@ +{ + "operationId": "Projects_Delete", + "parameters": { + "accountName": "PropTest01", + "api-version": "2026-05-01", + "projectName": "myProject", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Delete Project", + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiBlocklist.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiBlocklist.json new file mode 100644 index 000000000000..adc7180ea0e7 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiBlocklist.json @@ -0,0 +1,19 @@ +{ + "operationId": "RaiBlocklists_Delete", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiBlocklistName": "raiBlocklistName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "DeleteRaiBlocklist", + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiBlocklistItem.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiBlocklistItem.json new file mode 100644 index 000000000000..cb3881ad3bc6 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiBlocklistItem.json @@ -0,0 +1,20 @@ +{ + "operationId": "RaiBlocklistItems_Delete", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiBlocklistItemName": "raiBlocklistItemName", + "raiBlocklistName": "raiBlocklistName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "DeleteRaiBlocklistItem", + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiBlocklistItems.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiBlocklistItems.json new file mode 100644 index 000000000000..9b0c988edf1d --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiBlocklistItems.json @@ -0,0 +1,18 @@ +{ + "operationId": "RaiBlocklistItems_BatchDelete", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiBlocklistItemsNames": [ + "myblocklistitem1", + "myblocklistitem2" + ], + "raiBlocklistName": "raiBlocklistName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "DeleteRaiBlocklistItems", + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiExternalSafetyProvider.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiExternalSafetyProvider.json new file mode 100644 index 000000000000..2aaee5884b80 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiExternalSafetyProvider.json @@ -0,0 +1,17 @@ +{ + "operationId": "RaiExternalSafetyProvider_Delete", + "parameters": { + "api-version": "2026-05-01", + "safetyProviderName": "safetyProviderName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "DeleteRaiTopic", + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiPolicy.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiPolicy.json new file mode 100644 index 000000000000..a162de7fea99 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiPolicy.json @@ -0,0 +1,19 @@ +{ + "operationId": "RaiPolicies_Delete", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiPolicyName": "raiPolicyName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "DeleteRaiPolicy", + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiToolLabel.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiToolLabel.json new file mode 100644 index 000000000000..5c5000d2ab2f --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiToolLabel.json @@ -0,0 +1,22 @@ +{ + "operationId": "RaiToolLabels_Delete", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiToolConnectionName": "Web_Search", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "DeleteRaiToolLabel", + "responses": { + "202": { + "description": "Accepted -- delete operation started.", + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "description": "No Content -- RAI Tool Label does not exist." + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiTopic.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiTopic.json new file mode 100644 index 000000000000..4abe8a744fca --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteRaiTopic.json @@ -0,0 +1,19 @@ +{ + "operationId": "RaiTopics_Delete", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiTopicName": "raiTopicName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "DeleteRaiTopic", + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteSharedCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteSharedCommitmentPlan.json new file mode 100644 index 000000000000..72d623075724 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteSharedCommitmentPlan.json @@ -0,0 +1,19 @@ +{ + "operationId": "CommitmentPlans_DeletePlan", + "parameters": { + "api-version": "2026-05-01", + "commitmentPlanName": "commitmentPlanName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Delete Commitment Plan", + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteSharedCommitmentPlanAssociation.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteSharedCommitmentPlanAssociation.json new file mode 100644 index 000000000000..d334fc51db7c --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteSharedCommitmentPlanAssociation.json @@ -0,0 +1,20 @@ +{ + "operationId": "CommitmentPlans_DeleteAssociation", + "parameters": { + "api-version": "2026-05-01", + "commitmentPlanAssociationName": "commitmentPlanAssociationName", + "commitmentPlanName": "commitmentPlanName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "DeleteCommitmentPlan", + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteSubscriptionRaiPolicy.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteSubscriptionRaiPolicy.json new file mode 100644 index 000000000000..bbe475fc4ceb --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/DeleteSubscriptionRaiPolicy.json @@ -0,0 +1,19 @@ +{ + "operationId": "SubscriptionRaiPolicy_Delete", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiPolicyName": "raiPolicyName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "DeleteRaiPolicy", + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetAccount.json new file mode 100644 index 000000000000..312eb6c5a2cf --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetAccount.json @@ -0,0 +1,33 @@ +{ + "operationId": "Accounts_Get", + "parameters": { + "accountName": "myAccount", + "api-version": "2026-05-01", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Get Account", + "responses": { + "200": { + "body": { + "name": "myAccount", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount", + "kind": "Emotion", + "location": "westus", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "F0" + }, + "tags": { + "ExpiredDate": "2017/09/01", + "Owner": "felixwa" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetCommitmentPlan.json new file mode 100644 index 000000000000..ade147f22178 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetCommitmentPlan.json @@ -0,0 +1,28 @@ +{ + "operationId": "CommitmentPlans_Get", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "commitmentPlanName": "commitmentPlanName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "GetCommitmentPlan", + "responses": { + "200": { + "body": { + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/accounts/commitmentPlans", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/commitmentPlans/commitmentPlanName", + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "Speech2Text" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetDefenderForAISetting.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetDefenderForAISetting.json new file mode 100644 index 000000000000..60b750bd2a05 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetDefenderForAISetting.json @@ -0,0 +1,32 @@ +{ + "operationId": "DefenderForAISettings_Get", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "defenderForAISettingName": "Default", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "GetDefenderForAISetting", + "responses": { + "200": { + "body": { + "name": "Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdAt": "2022-04-03T04:41:33.937Z", + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetDeletedAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetDeletedAccount.json new file mode 100644 index 000000000000..d1d65db024fc --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetDeletedAccount.json @@ -0,0 +1,34 @@ +{ + "operationId": "DeletedAccounts_Get", + "parameters": { + "accountName": "myAccount", + "api-version": "2026-05-01", + "location": "westus", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Get Account", + "responses": { + "200": { + "body": { + "name": "myAccount", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.CognitiveServices/locations/westus/resourceGroups/myResourceGroup/deletedAccounts/myAccount", + "kind": "Emotion", + "location": "westus", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "F0" + }, + "tags": { + "ExpiredDate": "2017/09/01", + "Owner": "felixwa" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetDeployment.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetDeployment.json new file mode 100644 index 000000000000..e0730e53bb3a --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetDeployment.json @@ -0,0 +1,34 @@ +{ + "operationId": "Deployments_Get", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "deploymentName": "deploymentName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "GetDeployment", + "responses": { + "200": { + "body": { + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "properties": { + "deploymentState": "Running", + "model": { + "name": "ada", + "format": "OpenAI", + "version": "1" + }, + "provisioningState": "Succeeded", + "serviceTier": "Default" + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetEncryptionScope.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetEncryptionScope.json new file mode 100644 index 000000000000..9669dac48e6b --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetEncryptionScope.json @@ -0,0 +1,40 @@ +{ + "operationId": "EncryptionScopes_Get", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "encryptionScopeName": "encryptionScopeName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "GetEncryptionScope", + "responses": { + "200": { + "body": { + "name": "encryptionScopeName", + "type": "Microsoft.CognitiveServices/accounts/encryptionScopes", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName", + "properties": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "identityClientId": "00000000-0000-0000-0000-000000000000", + "keyName": "DevKeyWestUS2", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95" + }, + "provisioningState": "Succeeded", + "state": "Enabled" + }, + "systemData": { + "createdAt": "2023-06-08T06:35:08.0662558Z", + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2023-06-08T06:35:08.0662558Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetNetworkSecurityPerimeterConfigurations.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetNetworkSecurityPerimeterConfigurations.json new file mode 100644 index 000000000000..371d20f5150b --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetNetworkSecurityPerimeterConfigurations.json @@ -0,0 +1,48 @@ +{ + "operationId": "NetworkSecurityPerimeterConfigurations_Get", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "nspConfigurationName": "NSPConfigurationName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "GetNetworkSecurityPerimeterConfigurations", + "responses": { + "200": { + "body": { + "name": "networkSecurityPerimeterConfigurationName", + "type": "Microsoft.CognitiveServices/accounts/networkSecurityPerimeterConfigurations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/networkSecurityPerimeterConfigurations/config1", + "properties": { + "networkSecurityPerimeter": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.Network/networkSecurityPerimeters/perimeter", + "location": "East US", + "perimeterGuid": "00000000-0000-0000-0000-000000000000" + }, + "profile": { + "name": "profileName", + "accessRules": [ + { + "name": "ruleName", + "properties": { + "addressPrefixes": [ + "148.0.0.0/8", + "152.4.6.0/24" + ], + "direction": "Inbound" + } + } + ], + "accessRulesVersion": 1 + }, + "provisioningState": "Succeeded", + "resourceAssociation": { + "name": "associationName", + "accessMode": "Enforced" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetOperations.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetOperations.json new file mode 100644 index 000000000000..0e03252e67aa --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetOperations.json @@ -0,0 +1,45 @@ +{ + "operationId": "Operations_List", + "parameters": { + "api-version": "2026-05-01" + }, + "title": "Get Operations", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.CognitiveServices/accounts/read", + "display": { + "description": "Reads API accounts.", + "operation": "Read API Account", + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CognitiveServices/accounts/write", + "display": { + "description": "Writes API Accounts.", + "operation": "Write API Account", + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.CognitiveServices/accounts/delete", + "display": { + "description": "Deletes API accounts", + "operation": "Delete API Account", + "provider": "Microsoft Cognitive Services", + "resource": "Cognitive Services API Account" + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetPrivateEndpointConnection.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetPrivateEndpointConnection.json new file mode 100644 index 000000000000..265b022ac3ef --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetPrivateEndpointConnection.json @@ -0,0 +1,31 @@ +{ + "operationId": "PrivateEndpointConnections_Get", + "parameters": { + "accountName": "sto2527", + "api-version": "2026-05-01", + "monitor": "true", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "resourceGroupName": "res6977", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "GetPrivateEndpointConnection", + "responses": { + "200": { + "body": { + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "description": "Auto-Approved", + "actionsRequired": "None", + "status": "Approved" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetProject.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetProject.json new file mode 100644 index 000000000000..c0f9ed8e0488 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetProject.json @@ -0,0 +1,36 @@ +{ + "operationId": "Projects_Get", + "parameters": { + "accountName": "myAccount", + "api-version": "2026-05-01", + "projectName": "myProject", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Get Project", + "responses": { + "200": { + "body": { + "name": "myProject", + "type": "Microsoft.CognitiveServices/accounts/projects", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount/projects/myProject", + "location": "westus", + "properties": { + "description": "This is my project", + "displayName": "myProject", + "endpoints": { + "OpenAI Dall-E API": "https://customSubDomainName.openai.azure.com/", + "OpenAI Language Model Instance API": "https://customSubDomainName.openai.azure.com/" + }, + "isDefault": false, + "provisioningState": "Succeeded" + }, + "tags": { + "ExpiredDate": "2017/09/01", + "Owner": "felixwa" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetQuotaTier.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetQuotaTier.json new file mode 100644 index 000000000000..43cf0e5dc723 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetQuotaTier.json @@ -0,0 +1,28 @@ +{ + "operationId": "QuotaTiers_Get", + "parameters": { + "default": "default", + "api-version": "2026-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Get the Quota Tier information for a subscription", + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.CognitiveServices/quotaTiers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/quotaTiers/default", + "properties": { + "assignmentDate": "2025-06-09T18:13:29.389Z", + "currentTierName": "Free-Tier", + "tierUpgradeEligibilityInfo": { + "nextTierName": "Tier-1", + "upgradeApplicableDate": "2025-06-15T18:13:29.389Z", + "upgradeAvailabilityStatus": "Available" + }, + "tierUpgradePolicy": "OnceUpgradeIsAvailable" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiBlocklist.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiBlocklist.json new file mode 100644 index 000000000000..65f121ccb367 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiBlocklist.json @@ -0,0 +1,22 @@ +{ + "operationId": "RaiBlocklists_Get", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiBlocklistName": "raiBlocklistName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "GetRaiBlocklist", + "responses": { + "200": { + "body": { + "name": "raiBlocklistName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName", + "properties": { + "description": "This is a sample blocklist" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiBlocklistItem.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiBlocklistItem.json new file mode 100644 index 000000000000..affabdea848c --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiBlocklistItem.json @@ -0,0 +1,24 @@ +{ + "operationId": "RaiBlocklistItems_Get", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiBlocklistItemName": "raiBlocklistItemName", + "raiBlocklistName": "raiBlocklistName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "GetRaiBlocklistItem", + "responses": { + "200": { + "body": { + "name": "raiBlocklistItemName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName", + "properties": { + "isRegex": false, + "pattern": "Pattern To Block" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiContentFilter.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiContentFilter.json new file mode 100644 index 000000000000..fd6f4f71348a --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiContentFilter.json @@ -0,0 +1,24 @@ +{ + "operationId": "RaiContentFilters_Get", + "parameters": { + "api-version": "2026-05-01", + "filterName": "IndirectAttack", + "location": "WestUS", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "GetRaiContentFilters", + "responses": { + "200": { + "body": { + "name": "IndirectAttack", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/IndirectAttack", + "properties": { + "name": "Indirect Attack", + "isMultiLevelFilter": false, + "source": "Prompt" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiExternalSafetyProvider.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiExternalSafetyProvider.json new file mode 100644 index 000000000000..06fe22836b70 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiExternalSafetyProvider.json @@ -0,0 +1,28 @@ +{ + "operationId": "RaiExternalSafetyProvider_Get", + "parameters": { + "api-version": "2026-05-01", + "safetyProviderName": "safetyProviderName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "GetRaiExternalSafetyProvider", + "responses": { + "200": { + "body": { + "name": "safetyProviderName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/raiExternalSafetyProviders/safetyProviderName", + "properties": { + "createdAt": "2025-07-01T00:00:00Z", + "keyVaultUri": "https://example.vault.azure.net", + "lastModifiedAt": "2025-07-02T00:00:00Z", + "managedIdentity": "00000000-0000-0000-0000-000000000000", + "mode": "sync", + "providerId": "00000000-0000-0000-0000-000000000000", + "providerName": "safetyProviderName", + "secretName": "mySecretName", + "url": "https://example.webhook.endpoint" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiPolicy.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiPolicy.json new file mode 100644 index 000000000000..5b655b4b5bb1 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiPolicy.json @@ -0,0 +1,107 @@ +{ + "operationId": "RaiPolicies_Get", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "deploymentName": "deploymentName", + "effective": true, + "raiPolicyName": "raiPolicyName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "GetRaiPolicy", + "responses": { + "200": { + "body": { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "contentFilters": [ + { + "name": "Hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Jailbreak", + "blocking": true, + "enabled": true, + "source": "Prompt" + }, + { + "name": "Protected Material Text", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Protected Material Code", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Profanity", + "blocking": true, + "enabled": true, + "source": "Prompt" + } + ], + "mode": "Asynchronous_filter" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiToolLabel.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiToolLabel.json new file mode 100644 index 000000000000..3963fc3cf59c --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiToolLabel.json @@ -0,0 +1,44 @@ +{ + "operationId": "RaiToolLabels_Get", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiToolConnectionName": "ToolLabelName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "GetRaiToolLabel", + "responses": { + "200": { + "body": { + "name": "raiToolLabelName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiIfcToolLabels/raiIfcToolLabelName", + "properties": { + "accountScope": { + "labelValues": { + "confidentiality": "low", + "dataDirection": "egress" + } + }, + "projectScopes": [ + { + "labelValues": { + "confidentiality": "low", + "dataDirection": "egress" + }, + "project": "ProjectA" + }, + { + "labelValues": { + "confidentiality": "high", + "dataDirection": "egress" + }, + "project": "ProjectB" + } + ], + "toolConnectionName": "SampleToolLabel" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiTopic.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiTopic.json new file mode 100644 index 000000000000..6c0cd70b3777 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetRaiTopic.json @@ -0,0 +1,28 @@ +{ + "operationId": "RaiTopics_Get", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiTopicName": "raiTopicName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "GetRaiTopic", + "responses": { + "200": { + "body": { + "name": "raiTopicName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiTopics/raiTopicName", + "properties": { + "description": "This is a sample topic.", + "createdAt": "2025-07-01T00:00:00Z", + "lastModifiedAt": "2025-07-02T00:00:00Z", + "sampleBlobUrl": "https://example.blob.core.windows.net/sampleblob", + "status": "Succeeded", + "topicId": "00000000-0000-0000-0000-000000000000", + "topicName": "raiTopicName" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetSharedCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetSharedCommitmentPlan.json new file mode 100644 index 000000000000..e20ec3233f8e --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetSharedCommitmentPlan.json @@ -0,0 +1,33 @@ +{ + "operationId": "CommitmentPlans_GetPlan", + "parameters": { + "api-version": "2026-05-01", + "commitmentPlanName": "commitmentPlanName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Get Commitment Plan", + "responses": { + "200": { + "body": { + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "kind": "SpeechServices", + "location": "West US", + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "STT", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetSharedCommitmentPlanAssociation.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetSharedCommitmentPlanAssociation.json new file mode 100644 index 000000000000..14e77da3f6e9 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetSharedCommitmentPlanAssociation.json @@ -0,0 +1,23 @@ +{ + "operationId": "CommitmentPlans_GetAssociation", + "parameters": { + "api-version": "2026-05-01", + "commitmentPlanAssociationName": "commitmentPlanAssociationName", + "commitmentPlanName": "commitmentPlanName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "GetCommitmentPlan", + "responses": { + "200": { + "body": { + "name": "commitmentPlanAssociationName", + "type": "Microsoft.CognitiveServices/commitmentPlans/accountAssociations", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName/accountAssociations/commitmentPlanAssociationName", + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetSkus.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetSkus.json new file mode 100644 index 000000000000..6e8cbf684420 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetSkus.json @@ -0,0 +1,2166 @@ +{ + "operationId": "ResourceSkus_List", + "parameters": { + "api-version": "2026-05-01", + "subscriptionId": "f1c637e4-72ec-4f89-8d2b-0f933c036002" + }, + "title": "Regenerate Keys", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "F0", + "kind": "Bing.Speech", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Bing.Speech", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "SpeechTranslation", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextTranslation", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S5", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S6", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S7", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S8", + "kind": "Bing.Search.v7", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "Bing.Autosuggest.v7", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "Bing.CustomSearch", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "Bing.SpellCheck.v7", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Bing.EntitySearch", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "Bing.EntitySearch", + "locations": [ + "GLOBAL" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "AUSTRALIAEAST" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "BRAZILSOUTH" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "CENTRALUSEUAP" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "SpeakerRecognition", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "SpeakerRecognition", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "CustomSpeech", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S2", + "kind": "CustomSpeech", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "WESTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "WESTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "WESTEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "NORTHEUROPE" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "SOUTHEASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "EASTASIA" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "WESTCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "CustomVision.Training", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "CustomVision.Training", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "CustomVision.Prediction", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "CustomVision.Prediction", + "locations": [ + "SOUTHCENTRALUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "EASTUS" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ContentModerator", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "ContentModerator", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "Face", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "Face", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "LUIS", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "LUIS", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "ComputerVision", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S1", + "kind": "ComputerVision", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "F0", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Free" + }, + { + "name": "S0", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S1", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S2", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S3", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + }, + { + "name": "S4", + "kind": "TextAnalytics", + "locations": [ + "EASTUS2" + ], + "resourceType": "accounts", + "restrictions": [], + "tier": "Standard" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetSubscriptionRaiPolicy.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetSubscriptionRaiPolicy.json new file mode 100644 index 000000000000..0eb9caf953e3 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetSubscriptionRaiPolicy.json @@ -0,0 +1,107 @@ +{ + "operationId": "SubscriptionRaiPolicy_Get", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "deploymentName": "deploymentName", + "effective": true, + "raiPolicyName": "raiPolicyName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "GetRaiPolicy", + "responses": { + "200": { + "body": { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "contentFilters": [ + { + "name": "Hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Jailbreak", + "blocking": true, + "enabled": true, + "source": "Prompt" + }, + { + "name": "Protected Material Text", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Protected Material Code", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Profanity", + "blocking": true, + "enabled": true, + "source": "Prompt" + } + ], + "mode": "Asynchronous_filter" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetUsages.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetUsages.json new file mode 100644 index 000000000000..69b2d2211bde --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/GetUsages.json @@ -0,0 +1,30 @@ +{ + "operationId": "Accounts_ListUsages", + "parameters": { + "accountName": "TestUsage02", + "api-version": "2026-05-01", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "5a4f5c2e-6983-4ccb-bd34-2196d5b5bbd3" + }, + "title": "Get Usages", + "responses": { + "200": { + "body": { + "value": [ + { + "name": { + "localizedValue": "Face.Transactions", + "value": "Face.Transactions" + }, + "currentValue": 3, + "limit": 30000, + "nextResetTime": "2018-03-28T09:33:51Z", + "quotaPeriod": "30.00:00:00", + "status": "Included", + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListAccountModels.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListAccountModels.json new file mode 100644 index 000000000000..4f624d8b5503 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListAccountModels.json @@ -0,0 +1,189 @@ +{ + "operationId": "Accounts_ListModels", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "location": "location", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List AccountModels", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ada.1", + "format": "OpenAI", + "baseModel": { + "name": "ada", + "format": "OpenAI", + "version": "1" + }, + "capabilities": { + "completion": "true", + "fineTune": "true", + "inference": "false" + }, + "deprecation": { + "deprecationStatus": "Planned", + "fineTune": "2024-01-01T00:00:00Z", + "inference": "2024-01-01T00:00:00Z" + }, + "isDefaultVersion": false, + "lifecycleStatus": "Legacy", + "maxCapacity": 10, + "systemData": { + "createdAt": "2021-10-07T00:00:00Z", + "createdBy": "Microsoft", + "createdByType": "Application", + "lastModifiedAt": "2021-10-07T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedByType": "Application" + }, + "version": "1" + }, + { + "name": "dall-e-3", + "format": "OpenAI", + "capabilities": { + "imageGenerations": "true", + "inference": "true" + }, + "deprecation": { + "deprecationStatus": "Tentative", + "inference": "2025-06-30T00:00:00Z" + }, + "isDefaultVersion": true, + "lifecycleStatus": "GenerallyAvailable", + "maxCapacity": 2, + "modelCatalogAssetId": "azureml://registries/azure-openai/models/dall-e-3/versions/3.0", + "systemData": { + "createdAt": "2023-08-11T00:00:00Z", + "createdBy": "Microsoft", + "createdByType": "Application", + "lastModifiedAt": "2023-08-11T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedByType": "Application" + }, + "version": "3.0" + }, + { + "name": "gpt-35-turbo", + "format": "OpenAI", + "capabilities": { + "chatCompletion": "true", + "completion": "true", + "fineTune": "false", + "scaleType": "Manual,Standard" + }, + "deprecation": { + "deprecationStatus": "Planned", + "inference": "2025-04-30T00:00:00Z" + }, + "isDefaultVersion": false, + "lifecycleStatus": "Deprecated", + "maxCapacity": 9, + "systemData": { + "createdAt": "2023-03-09T00:00:00Z", + "createdBy": "Microsoft", + "createdByType": "Application", + "lastModifiedAt": "2023-07-06T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedByType": "Application" + }, + "version": "0301" + }, + { + "name": "gpt-4o", + "format": "OpenAI", + "capabilities": { + "chat": "true", + "completion": "true", + "fineTune": "false", + "inference": "true", + "vision": "true" + }, + "deprecation": { + "deprecationStatus": "Tentative", + "inference": "2025-09-15T00:00:00Z" + }, + "lifecycleStatus": "Deprecating", + "maxCapacity": 50, + "modelCatalogAssetId": "azureml://registries/azure-openai/models/gpt-4o/versions/2024-05-13", + "replacementConfig": { + "autoUpgradeStartDate": "2025-03-26T07:00:00Z", + "targetModelName": "gpt-4.1", + "targetModelVersion": "2025-04-14", + "upgradeOnExpiryLeadTimeDays": 7 + }, + "systemData": { + "createdAt": "2024-05-13T00:00:00Z", + "createdBy": "Microsoft", + "createdByType": "Application", + "lastModifiedAt": "2024-12-15T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedByType": "Application" + }, + "version": "2024-05-13" + }, + { + "name": "Llama-3.2-90B-Vision-Instruct", + "format": "Meta", + "capabilities": { + "chatCompletion": "true" + }, + "deprecation": { + "deprecationStatus": "Tentative", + "inference": "2099-12-31T00:00:00Z" + }, + "isDefaultVersion": false, + "lifecycleStatus": "Stable", + "maxCapacity": 3, + "modelCatalogAssetId": "azureml://registries/azureml-meta/models/Llama-3.2-90B-Vision-Instruct/versions/2", + "systemData": { + "createdAt": "2024-10-01T00:00:00Z", + "createdBy": "Microsoft", + "createdByType": "Application", + "lastModifiedAt": "2025-04-16T04:45:33.9367873Z", + "lastModifiedBy": "MaaSModelConverter", + "lastModifiedByType": "Application" + }, + "version": "2" + }, + { + "name": "gpt-4o", + "format": "OpenAI", + "capabilities": { + "chat": "true", + "completion": "true", + "fineTune": "false", + "functionCalling": "true", + "inference": "true", + "vision": "true" + }, + "finetuneCapabilities": { + "chat": "true", + "completion": "true", + "fineTune": "true", + "inference": "true", + "scaleType": "Manual" + }, + "lifecycleStatus": "GenerallyAvailable", + "maxCapacity": 50, + "modelCatalogAssetId": "azureml://registries/azure-openai/models/gpt-4o/versions/2024-08-06", + "systemData": { + "createdAt": "2024-08-06T00:00:00Z", + "createdBy": "Microsoft", + "createdByType": "Application", + "lastModifiedAt": "2024-11-01T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedByType": "Application" + }, + "version": "2024-08-06" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListAccountsByResourceGroup.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListAccountsByResourceGroup.json new file mode 100644 index 000000000000..4407e4ce97eb --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListAccountsByResourceGroup.json @@ -0,0 +1,52 @@ +{ + "operationId": "Accounts_ListByResourceGroup", + "parameters": { + "api-version": "2026-05-01", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List Accounts by Resource Group", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myAccount", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount", + "kind": "Emotion", + "location": "westus", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "F0" + }, + "tags": { + "ExpiredDate": "2017/09/01", + "Owner": "felixwa" + } + }, + { + "name": "TestPropertyWU2", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-07T04%3A32%3A38.9187216Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/TestPropertyWU2", + "kind": "Face", + "location": "westus", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/face/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + }, + "tags": {} + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListAccountsBySubscription.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListAccountsBySubscription.json new file mode 100644 index 000000000000..84c7a918f8c5 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListAccountsBySubscription.json @@ -0,0 +1,79 @@ +{ + "operationId": "Accounts_List", + "parameters": { + "api-version": "2026-05-01", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List Accounts by Subscription", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "bingSearch", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-03-27T11%3A19%3A08.762494Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch", + "kind": "Bing.Search", + "location": "global", + "properties": { + "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S1" + } + }, + { + "name": "CrisProd", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-03-31T08%3A57%3A07.4499566Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/CrisProd", + "kind": "CRIS", + "location": "westus", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/sts/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + }, + "tags": { + "can't delete it successfully": "v-yunjin" + } + }, + { + "name": "rayrptest0308", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-03-27T11%3A15%3A23.5232645Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/rayrptest0308", + "kind": "Face", + "location": "westus", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/face/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + }, + { + "name": "raytest02", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-04T02%3A07%3A07.3957572Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/raytest02", + "kind": "Emotion", + "location": "westus", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListBlocklistItems.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListBlocklistItems.json new file mode 100644 index 000000000000..930cd813c2dd --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListBlocklistItems.json @@ -0,0 +1,35 @@ +{ + "operationId": "RaiBlocklistItems_List", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiBlocklistName": "raiBlocklistName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListBlocklistItems", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "raiBlocklistItemName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName", + "properties": { + "isRegex": false, + "pattern": "Pattern To Block" + } + }, + { + "name": "raiBlocklistItemName2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName2", + "properties": { + "isRegex": false, + "pattern": "Another Pattern To Block" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListBlocklists.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListBlocklists.json new file mode 100644 index 000000000000..87e6694809b0 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListBlocklists.json @@ -0,0 +1,25 @@ +{ + "operationId": "RaiBlocklists_List", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListBlocklists", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "raiBlocklistName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName", + "properties": { + "description": "This is a sample blocklist" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListCommitmentPlans.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListCommitmentPlans.json new file mode 100644 index 000000000000..c3b29f0df32b --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListCommitmentPlans.json @@ -0,0 +1,31 @@ +{ + "operationId": "CommitmentPlans_List", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "ListCommitmentPlans", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/accounts/commitmentPlans", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/commitmentPlans/commitmentPlanName", + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "Speech2Text" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListCommitmentTiers.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListCommitmentTiers.json new file mode 100644 index 000000000000..42c7b033a453 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListCommitmentTiers.json @@ -0,0 +1,30 @@ +{ + "operationId": "CommitmentTiers_List", + "parameters": { + "api-version": "2026-05-01", + "location": "location", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "ListCommitmentTiers", + "responses": { + "200": { + "body": { + "value": [ + { + "cost": {}, + "hostingModel": "Web", + "kind": "TextAnalytics", + "planType": "TA", + "quota": { + "quantity": 1000000, + "unit": "Transaction" + }, + "skuName": "S", + "tier": "T1" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListDefenderForAISetting.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListDefenderForAISetting.json new file mode 100644 index 000000000000..5fa7f8e8d254 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListDefenderForAISetting.json @@ -0,0 +1,35 @@ +{ + "operationId": "DefenderForAISettings_List", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListDefenderForAISetting", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdAt": "2022-04-03T04:41:33.937Z", + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListDeletedAccountsBySubscription.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListDeletedAccountsBySubscription.json new file mode 100644 index 000000000000..8cabb834aee5 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListDeletedAccountsBySubscription.json @@ -0,0 +1,79 @@ +{ + "operationId": "DeletedAccounts_List", + "parameters": { + "api-version": "2026-05-01", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List Deleted Accounts by Subscription", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "bingSearch", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-03-27T11%3A19%3A08.762494Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch", + "kind": "Bing.Search", + "location": "global", + "properties": { + "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S1" + } + }, + { + "name": "CrisProd", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-03-31T08%3A57%3A07.4499566Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/CrisProd", + "kind": "CRIS", + "location": "westus", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/sts/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + }, + "tags": { + "can't delete it successfully": "v-yunjin" + } + }, + { + "name": "rayrptest0308", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-03-27T11%3A15%3A23.5232645Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/rayrptest0308", + "kind": "Face", + "location": "westus", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/face/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + }, + { + "name": "raytest02", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-04T02%3A07%3A07.3957572Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/raytest02", + "kind": "Emotion", + "location": "westus", + "properties": { + "endpoint": "https://westus.api.cognitive.microsoft.com/emotion/v1.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListDeploymentSkus.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListDeploymentSkus.json new file mode 100644 index 000000000000..420b6cf7cd65 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListDeploymentSkus.json @@ -0,0 +1,36 @@ +{ + "operationId": "Deployments_ListSkus", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "deploymentName": "deploymentName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListDeploymentSkus", + "responses": { + "200": { + "body": { + "value": [ + { + "capacity": { + "default": 100, + "allowedValues": [ + 100, + 200 + ], + "maximum": 1000, + "minimum": 100, + "step": 100 + }, + "resourceType": "Microsoft.CognitiveServices/accounts/deployments", + "sku": { + "name": "Standard", + "capacity": 1 + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListDeployments.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListDeployments.json new file mode 100644 index 000000000000..58bee469e165 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListDeployments.json @@ -0,0 +1,37 @@ +{ + "operationId": "Deployments_List", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "ListDeployments", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "properties": { + "deploymentState": "Running", + "model": { + "name": "ada", + "format": "OpenAI", + "version": "1" + }, + "provisioningState": "Succeeded", + "serviceTier": "Default" + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListEncryptionScopes.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListEncryptionScopes.json new file mode 100644 index 000000000000..5b8adc7b8c0f --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListEncryptionScopes.json @@ -0,0 +1,43 @@ +{ + "operationId": "EncryptionScopes_List", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListEncryptionScopes", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "encryptionScopeName", + "type": "Microsoft.CognitiveServices/accounts/encryptionScopes", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName", + "properties": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "identityClientId": "00000000-0000-0000-0000-000000000000", + "keyName": "DevKeyWestUS2", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95" + }, + "provisioningState": "Succeeded", + "state": "Enabled" + }, + "systemData": { + "createdAt": "2023-06-08T06:35:08.0662558Z", + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2023-06-08T06:35:08.0662558Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListKeys.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListKeys.json new file mode 100644 index 000000000000..c80a7e64645b --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListKeys.json @@ -0,0 +1,18 @@ +{ + "operationId": "Accounts_ListKeys", + "parameters": { + "accountName": "myAccount", + "api-version": "2026-05-01", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List Keys", + "responses": { + "200": { + "body": { + "key1": "KEY1", + "key2": "KEY2" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListLocationBasedModelCapacities.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListLocationBasedModelCapacities.json new file mode 100644 index 000000000000..7fc4588e443e --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListLocationBasedModelCapacities.json @@ -0,0 +1,36 @@ +{ + "operationId": "LocationBasedModelCapacities_List", + "parameters": { + "api-version": "2026-05-01", + "location": "WestUS", + "modelFormat": "OpenAI", + "modelName": "ada", + "modelVersion": "1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListLocationBasedModelCapacities", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard", + "type": "Microsoft.CognitiveServices/locations/models/skuCapacities", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/models/OpenAI.ada.1/skuCapacities/Standard", + "location": "WestUS", + "properties": { + "availableCapacity": 300, + "availableFinetuneCapacity": 20, + "model": { + "name": "ada", + "format": "OpenAI", + "version": "1" + }, + "skuName": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListLocationModels.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListLocationModels.json new file mode 100644 index 000000000000..6a44af8050ab --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListLocationModels.json @@ -0,0 +1,292 @@ +{ + "operationId": "Models_List", + "parameters": { + "api-version": "2026-05-01", + "location": "WestUS", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListLocationModels", + "responses": { + "200": { + "body": { + "value": [ + { + "kind": "OpenAI", + "model": { + "name": "ada", + "format": "OpenAI", + "capabilities": { + "FineTuneTokensMaxValue": "2000000000", + "FineTuneTokensMaxValuePerExample": "4096", + "completion": "true", + "inference": "false", + "scaleType": "Manual", + "search": "true" + }, + "deprecation": { + "deprecationStatus": "Planned", + "fineTune": "2024-06-14T00:00:00Z", + "inference": "2024-06-14T00:00:00Z" + }, + "lifecycleStatus": "Legacy", + "maxCapacity": 3, + "skus": [ + { + "name": "provisioned", + "capacity": { + "default": 100, + "maximum": 1000, + "minimum": 100, + "step": 100 + }, + "usageName": "OpenAI.Provisioned.Class1" + } + ], + "systemData": { + "createdAt": "2021-10-07T00:00:00Z", + "createdBy": "Microsoft", + "lastModifiedAt": "2021-10-07T00:00:00Z", + "lastModifiedBy": "Microsoft" + }, + "version": "1" + }, + "skuName": "S0" + }, + { + "kind": "AIServices", + "model": { + "name": "dall-e-3", + "format": "OpenAI", + "capabilities": { + "imageGenerations": "true", + "inference": "true" + }, + "deprecation": { + "deprecationStatus": "Tentative", + "inference": "2025-06-30T00:00:00Z" + }, + "isDefaultVersion": true, + "lifecycleStatus": "GenerallyAvailable", + "maxCapacity": 2, + "modelCatalogAssetId": "azureml://registries/azure-openai/models/dall-e-3/versions/3.0", + "skus": [ + { + "name": "Provisioned", + "capacity": { + "default": 300, + "maximum": 60000, + "minimum": 300, + "step": 100 + }, + "deprecationDate": "2025-09-30T00:00:00Z", + "usageName": "OpenAI.Provisioned.Dalle" + } + ], + "systemData": { + "createdAt": "2023-08-11T00:00:00Z", + "createdBy": "Microsoft", + "lastModifiedAt": "2023-08-11T00:00:00Z", + "lastModifiedBy": "Microsoft" + }, + "version": "3.0" + }, + "skuName": "S0" + }, + { + "kind": "OpenAI", + "model": { + "name": "gpt-35-turbo", + "format": "OpenAI", + "capabilities": { + "chatCompletion": "true", + "completion": "true", + "maxTotalToken": "4096", + "scaleType": "Manual,Standard" + }, + "deprecation": { + "deprecationStatus": "Planned", + "inference": "2025-04-30T00:00:00Z" + }, + "isDefaultVersion": false, + "lifecycleStatus": "Deprecated", + "maxCapacity": 9, + "skus": [ + { + "name": "Standard", + "capacity": { + "default": 120, + "maximum": 1000000 + }, + "deprecationDate": "2025-02-13T00:00:00Z", + "usageName": "OpenAI.Standard.gpt-35-turbo" + }, + { + "name": "Provisioned", + "capacity": { + "default": 300, + "maximum": 30000, + "minimum": 300, + "step": 100 + }, + "deprecationDate": "2025-05-15T00:00:00Z", + "usageName": "OpenAI.Provisioned.gpt-35-turbo" + } + ], + "systemData": { + "createdAt": "2023-03-09T00:00:00Z", + "createdBy": "Microsoft", + "createdByType": "Application", + "lastModifiedAt": "2023-07-06T00:00:00Z", + "lastModifiedBy": "Microsoft", + "lastModifiedByType": "Application" + }, + "version": "0301" + }, + "skuName": "S0" + }, + { + "kind": "OpenAI", + "model": { + "name": "gpt-4o", + "format": "OpenAI", + "capabilities": { + "chat": "true", + "completion": "true", + "fineTune": "false", + "inference": "true", + "scaleType": "Manual,Provisioned", + "vision": "true" + }, + "deprecation": { + "deprecationStatus": "Tentative", + "inference": "2025-09-15T00:00:00Z" + }, + "lifecycleStatus": "Deprecating", + "maxCapacity": 50, + "modelCatalogAssetId": "azureml://registries/azure-openai/models/gpt-4o/versions/2024-05-13", + "replacementConfig": { + "autoUpgradeStartDate": "2025-03-26T07:00:00Z", + "targetModelName": "gpt-4.1", + "targetModelVersion": "2025-04-14", + "upgradeOnExpiryLeadTimeDays": 7 + }, + "skus": [ + { + "name": "provisioned", + "capacity": { + "default": 100, + "maximum": 2000, + "minimum": 50, + "step": 50 + }, + "usageName": "OpenAI.Provisioned.GPT4o" + } + ], + "systemData": { + "createdAt": "2024-05-13T00:00:00Z", + "createdBy": "Microsoft", + "lastModifiedAt": "2024-12-15T00:00:00Z", + "lastModifiedBy": "Microsoft" + }, + "version": "2024-05-13" + }, + "skuName": "S0" + }, + { + "kind": "AIServices", + "model": { + "name": "Llama-3.2-90B-Vision-Instruct", + "format": "Meta", + "capabilities": { + "chatCompletion": "true" + }, + "deprecation": { + "inference": "2099-12-31T00:00:00Z" + }, + "isDefaultVersion": false, + "lifecycleStatus": "Stable", + "maxCapacity": 3, + "modelCatalogAssetId": "azureml://registries/azureml-meta/models/Llama-3.2-90B-Vision-Instruct/versions/2", + "skus": [ + { + "name": "GlobalStandard", + "capacity": { + "default": 1, + "maximum": 1 + }, + "usageName": "AIServices.GlobalStandard.MaaS" + } + ], + "systemData": { + "createdAt": "2024-10-01T00:00:00Z", + "createdBy": "Microsoft", + "createdByType": "Application", + "lastModifiedAt": "2025-04-16T04:45:33.9367873Z", + "lastModifiedBy": "MaaSModelConverter", + "lastModifiedByType": "Application" + }, + "version": "2" + }, + "skuName": "S0" + }, + { + "kind": "OpenAI", + "model": { + "name": "gpt-4o", + "format": "OpenAI", + "capabilities": { + "chat": "true", + "completion": "true", + "fineTune": "false", + "functionCalling": "true", + "inference": "true", + "scaleType": "Manual,Standard,Provisioned", + "vision": "true" + }, + "finetuneCapabilities": { + "chat": "true", + "completion": "true", + "fineTune": "true", + "inference": "true", + "scaleType": "Manual" + }, + "lifecycleStatus": "GenerallyAvailable", + "maxCapacity": 50, + "modelCatalogAssetId": "azureml://registries/azure-openai/models/gpt-4o/versions/2024-08-06", + "skus": [ + { + "name": "Standard", + "capacity": { + "default": 10, + "maximum": 100, + "minimum": 1, + "step": 1 + }, + "usageName": "OpenAI.Standard.GPT4o" + }, + { + "name": "provisioned", + "capacity": { + "default": 100, + "maximum": 2000, + "minimum": 50, + "step": 50 + }, + "usageName": "OpenAI.Provisioned.GPT4o" + } + ], + "systemData": { + "createdAt": "2024-08-06T00:00:00Z", + "createdBy": "Microsoft", + "lastModifiedAt": "2024-11-01T00:00:00Z", + "lastModifiedBy": "Microsoft" + }, + "version": "2024-08-06" + }, + "skuName": "S0" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListModelCapacities.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListModelCapacities.json new file mode 100644 index 000000000000..3a0bd36593b1 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListModelCapacities.json @@ -0,0 +1,35 @@ +{ + "operationId": "ModelCapacities_List", + "parameters": { + "api-version": "2026-05-01", + "modelFormat": "OpenAI", + "modelName": "ada", + "modelVersion": "1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListModelCapacities", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard", + "type": "Microsoft.CognitiveServices/locations/models/skuCapacities", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/models/OpenAI.ada.1/skuCapacities/Standard", + "location": "WestUS", + "properties": { + "availableCapacity": 300, + "availableFinetuneCapacity": 20, + "model": { + "name": "ada", + "format": "OpenAI", + "version": "1" + }, + "skuName": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListNetworkSecurityPerimeterConfigurations.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListNetworkSecurityPerimeterConfigurations.json new file mode 100644 index 000000000000..6a08b9803086 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListNetworkSecurityPerimeterConfigurations.json @@ -0,0 +1,51 @@ +{ + "operationId": "NetworkSecurityPerimeterConfigurations_List", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListNetworkSecurityPerimeterConfigurations", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "networkSecurityPerimeterConfigurationName", + "type": "Microsoft.CognitiveServices/accounts/networkSecurityPerimeterConfigurations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/networkSecurityPerimeterConfigurations/config1", + "properties": { + "networkSecurityPerimeter": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.Network/networkSecurityPerimeters/perimeter", + "location": "East US", + "perimeterGuid": "00000000-0000-0000-0000-000000000000" + }, + "profile": { + "name": "profileName", + "accessRules": [ + { + "name": "ruleName", + "properties": { + "addressPrefixes": [ + "148.0.0.0/8", + "152.4.6.0/24" + ], + "direction": "Inbound" + } + } + ], + "accessRulesVersion": 1 + }, + "provisioningState": "Succeeded", + "resourceAssociation": { + "name": "associationName", + "accessMode": "Enforced" + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListPrivateEndpointConnections.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListPrivateEndpointConnections.json new file mode 100644 index 000000000000..cf9541b23dd8 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListPrivateEndpointConnections.json @@ -0,0 +1,33 @@ +{ + "operationId": "PrivateEndpointConnections_List", + "parameters": { + "accountName": "sto2527", + "api-version": "2026-05-01", + "resourceGroupName": "res6977", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "GetPrivateEndpointConnection", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "description": "Auto-Approved", + "actionsRequired": "None", + "status": "Approved" + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListPrivateLinkResources.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListPrivateLinkResources.json new file mode 100644 index 000000000000..6b389a785029 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListPrivateLinkResources.json @@ -0,0 +1,32 @@ +{ + "operationId": "PrivateLinkResources_List", + "parameters": { + "accountName": "sto2527", + "api-version": "2026-05-01", + "resourceGroupName": "res6977", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "ListPrivateLinkResources", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "blob", + "type": "Microsoft.CognitiveServices/accounts/privateLinkResources", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res6977/providers/Microsoft.CognitiveServices/accounts/sto2527/privateLinkResources/account", + "properties": { + "groupId": "account", + "requiredMembers": [ + "default" + ], + "requiredZoneNames": [ + "privatelink.cognitiveservices.azure.com" + ] + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListProjects.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListProjects.json new file mode 100644 index 000000000000..dae9182be365 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListProjects.json @@ -0,0 +1,57 @@ +{ + "operationId": "Projects_List", + "parameters": { + "accountName": "myAccount", + "api-version": "2026-05-01", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List Project", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myProject", + "type": "Microsoft.CognitiveServices/accounts/projects", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount/projects/myProject", + "location": "westus", + "properties": { + "description": "This is my project 1", + "displayName": "myProject1", + "endpoints": { + "OpenAI Dall-E API": "https://customSubDomainName.openai.azure.com/", + "OpenAI Language Model Instance API": "https://customSubDomainName.openai.azure.com/" + }, + "isDefault": true, + "provisioningState": "Succeeded" + }, + "tags": { + "ExpiredDate": "2017/09/01", + "Owner": "felixwa" + } + }, + { + "name": "myProject-2", + "type": "Microsoft.CognitiveServices/accounts/projects", + "etag": "W/\"datetime'2017-04-07T04%3A32%3A38.9187216Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount/projects/myProject-2", + "location": "westus", + "properties": { + "description": "This is my project 2", + "displayName": "myProject2", + "endpoints": { + "OpenAI Dall-E API": "https://customSubDomainName2.openai.azure.com/", + "OpenAI Language Model Instance API": "https://customSubDomainName2.openai.azure.com/" + }, + "isDefault": false, + "provisioningState": "Succeeded" + }, + "tags": {} + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListQuotaTiers.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListQuotaTiers.json new file mode 100644 index 000000000000..33d983056d18 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListQuotaTiers.json @@ -0,0 +1,31 @@ +{ + "operationId": "QuotaTiers_ListBySubscription", + "parameters": { + "api-version": "2026-05-01", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List the Quota Tier for a subscription", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.CognitiveServices/quotaTiers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/quotaTiers/default", + "properties": { + "assignmentDate": "2025-06-09T18:13:29.389Z", + "currentTierName": "Free-Tier", + "tierUpgradeEligibilityInfo": { + "nextTierName": "Tier-1", + "upgradeApplicableDate": "2025-06-15T18:13:29.389Z", + "upgradeAvailabilityStatus": "Available" + }, + "tierUpgradePolicy": "OnceUpgradeIsAvailable" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListRaiContentFilters.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListRaiContentFilters.json new file mode 100644 index 000000000000..17ce6d2f2356 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListRaiContentFilters.json @@ -0,0 +1,102 @@ +{ + "operationId": "RaiContentFilters_List", + "parameters": { + "api-version": "2026-05-01", + "location": "WestUS", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListRaiContentFilters", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Hate", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Hate", + "properties": { + "name": "Hate", + "isMultiLevelFilter": true + } + }, + { + "name": "Sexual", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Sexual", + "properties": { + "name": "Sexual", + "isMultiLevelFilter": true + } + }, + { + "name": "Violence", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Violence", + "properties": { + "name": "Violence", + "isMultiLevelFilter": true + } + }, + { + "name": "Selfharm", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Selfharm", + "properties": { + "name": "Selfharm", + "isMultiLevelFilter": true + } + }, + { + "name": "Jailbreak", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Jailbreak", + "properties": { + "name": "Jailbreak", + "isMultiLevelFilter": false, + "source": "Prompt" + } + }, + { + "name": "ProtectedMaterialText", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/ProtectedMaterialText", + "properties": { + "name": "Protected Material Text", + "isMultiLevelFilter": false, + "source": "Completion" + } + }, + { + "name": "ProtectedMaterialCode", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/ProtectedMaterialCode", + "properties": { + "name": "Protected Material Code", + "isMultiLevelFilter": false, + "source": "Completion" + } + }, + { + "name": "Profanity", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/Profanity", + "properties": { + "name": "Profanity", + "isMultiLevelFilter": false + } + }, + { + "name": "IndirectAttack", + "type": "Microsoft.CognitiveServices/locations/raiContentFilters", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/raiContentFilters/IndirectAttack", + "properties": { + "name": "Indirect Attack", + "isMultiLevelFilter": false, + "source": "Prompt" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListRaiExternalSafetyProviders.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListRaiExternalSafetyProviders.json new file mode 100644 index 000000000000..3b1555af1a55 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListRaiExternalSafetyProviders.json @@ -0,0 +1,61 @@ +{ + "operationId": "RaiExternalSafetyProviders_List", + "parameters": { + "api-version": "2026-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListRaiExternalSafetyProviders", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "purview", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/raiExternalSafetyProviders/purview", + "properties": { + "createdAt": "2025-07-01T00:00:00Z", + "keyVaultUri": "https://example.vault.azure.net", + "lastModifiedAt": "2025-07-02T00:00:00Z", + "managedIdentity": "00000000-0000-0000-0000-000000000000", + "mode": "sync", + "providerId": "00000000-0000-0000-0000-000000000000", + "providerName": "purview", + "secretName": "mySecretName", + "url": "https://example.webhook.endpoint" + } + }, + { + "name": "microsoftDefenderForCloud", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/raiExternalSafetyProviders/microsoftDefenderForCloud", + "properties": { + "createdAt": "2025-07-01T00:00:00Z", + "keyVaultUri": "https://example.vault.azure.net", + "lastModifiedAt": "2025-07-02T00:00:00Z", + "managedIdentity": "00000000-0000-0000-0000-000000000000", + "mode": "sync", + "providerId": "00000000-0000-0000-0000-000000000000", + "providerName": "microsoftDefenderForCloud", + "secretName": "mySecretName", + "url": "https://example.webhook.endpoint" + } + }, + { + "name": "sampleSafetyProvider", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/raiExternalSafetyProviders/sampleSafetyProvider", + "properties": { + "createdAt": "2025-07-01T00:00:00Z", + "keyVaultUri": "https://example.vault.azure.net", + "lastModifiedAt": "2025-07-02T00:00:00Z", + "managedIdentity": "00000000-0000-0000-0000-000000000000", + "mode": "sync", + "providerId": "00000000-0000-0000-0000-000000000000", + "providerName": "sampleSafetyProvider", + "secretName": "mySecretName", + "url": "https://example.webhook.endpoint" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListRaiPolicies.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListRaiPolicies.json new file mode 100644 index 000000000000..9b02a035791b --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListRaiPolicies.json @@ -0,0 +1,108 @@ +{ + "operationId": "RaiPolicies_List", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListRaiPolicies", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "contentFilters": [ + { + "name": "Hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Jailbreak", + "blocking": true, + "enabled": true, + "source": "Prompt" + }, + { + "name": "Protected Material Text", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Protected Material Code", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Profanity", + "blocking": true, + "enabled": true, + "source": "Prompt" + } + ], + "mode": "Asynchronous_filter" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListRaiToolLabels.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListRaiToolLabels.json new file mode 100644 index 000000000000..a094f06b0950 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListRaiToolLabels.json @@ -0,0 +1,44 @@ +{ + "operationId": "RaiToolLabels_List", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListRaiToolLabels", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "raiIfcToolLabelName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiIfcToolLabels/raiIfcToolLabelName", + "properties": { + "accountScope": { + "labelValues": { + "confidentiality": "low" + } + }, + "projectScopes": [ + { + "labelValues": { + "confidentiality": "low" + }, + "project": "hualiang-project" + }, + { + "labelValues": { + "confidentiality": "low" + }, + "project": "sahana-project" + } + ], + "toolConnectionName": "Web_Search" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListRaiTopics.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListRaiTopics.json new file mode 100644 index 000000000000..58599ece5d9e --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListRaiTopics.json @@ -0,0 +1,31 @@ +{ + "operationId": "RaiTopics_List", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ListRaiTopics", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "raiTopicName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiTopics/raiTopicName", + "properties": { + "description": "This is a sample topic.", + "createdAt": "2025-07-01T00:00:00Z", + "lastModifiedAt": "2025-07-02T00:00:00Z", + "sampleBlobUrl": "https://example.blob.core.windows.net/sampleblob", + "status": "Succeeded", + "topicId": "00000000-0000-0000-0000-000000000000", + "topicName": "raiTopicName" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListSharedCommitmentPlanAssociations.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListSharedCommitmentPlanAssociations.json new file mode 100644 index 000000000000..e10b66cae90f --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListSharedCommitmentPlanAssociations.json @@ -0,0 +1,26 @@ +{ + "operationId": "CommitmentPlans_ListAssociations", + "parameters": { + "api-version": "2026-05-01", + "commitmentPlanName": "commitmentPlanName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "ListCommitmentPlans", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "accountAssociationName", + "type": "Microsoft.CognitiveServices/commitmentPlans/accountAssociations", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName/accountAssociations/accountAssociationName", + "properties": { + "accountId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListSharedCommitmentPlansByResourceGroup.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListSharedCommitmentPlansByResourceGroup.json new file mode 100644 index 000000000000..fd4b906b154f --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListSharedCommitmentPlansByResourceGroup.json @@ -0,0 +1,36 @@ +{ + "operationId": "CommitmentPlans_ListPlansByResourceGroup", + "parameters": { + "api-version": "2026-05-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List Commitment Plans by Resource Group", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "kind": "SpeechServices", + "location": "West US", + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "STT", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListSharedCommitmentPlansBySubscription.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListSharedCommitmentPlansBySubscription.json new file mode 100644 index 000000000000..acd7faa022b9 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListSharedCommitmentPlansBySubscription.json @@ -0,0 +1,35 @@ +{ + "operationId": "CommitmentPlans_ListPlansBySubscription", + "parameters": { + "api-version": "2026-05-01", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List Accounts by Subscription", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "kind": "SpeechServices", + "location": "West US", + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "STT", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListSkus.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListSkus.json new file mode 100644 index 000000000000..31b0718ac2fc --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListSkus.json @@ -0,0 +1,32 @@ +{ + "operationId": "Accounts_ListSkus", + "parameters": { + "accountName": "myAccount", + "api-version": "2026-05-01", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List SKUs", + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.CognitiveServices/accounts", + "sku": { + "name": "F0", + "tier": "Free" + } + }, + { + "resourceType": "Microsoft.CognitiveServices/accounts", + "sku": { + "name": "S0", + "tier": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListUsages.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListUsages.json new file mode 100644 index 000000000000..327b6dc86f62 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ListUsages.json @@ -0,0 +1,26 @@ +{ + "operationId": "Usages_List", + "parameters": { + "api-version": "2026-05-01", + "location": "WestUS", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Get Usages", + "responses": { + "200": { + "body": { + "value": [ + { + "name": { + "localizedValue": "Cognitive Services total account limit", + "value": "AccountCount" + }, + "currentValue": 3, + "limit": 200, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/createOrUpdateManagedNetworkV2.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/createOrUpdateManagedNetworkV2.json new file mode 100644 index 000000000000..20f1b6dca6a1 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/createOrUpdateManagedNetworkV2.json @@ -0,0 +1,59 @@ +{ + "operationId": "ManagedNetworkSettings_Put", + "parameters": { + "accountName": "cognitive-account-name", + "api-version": "2026-05-01", + "body": { + "properties": { + "managedNetwork": { + "firewallSku": "Standard", + "isolationMode": "AllowOnlyApprovedOutbound", + "outboundRules": { + "rule_name_1": { + "type": "FQDN", + "category": "UserDefined", + "destination": "destination_endpoint" + } + } + } + } + }, + "managedNetworkName": "default", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Put ManagedNetworkSettings", + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.CognitiveServices/accounts/managedNetworks", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default", + "properties": { + "managedNetwork": { + "firewallPublicIpAddress": "22.22.131.49", + "firewallSku": "Standard", + "isolationMode": "AllowOnlyApprovedOutbound", + "networkId": "00000000-1111-2222-3333-444444444444", + "outboundRules": { + "rule_name_1": { + "type": "FQDN", + "category": "UserDefined", + "destination": "destination_endpoint", + "status": "Active" + } + }, + "provisioningState": "Succeeded" + }, + "provisioningState": "Succeeded" + } + }, + "headers": {} + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/createOrUpdateRuleV2.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/createOrUpdateRuleV2.json new file mode 100644 index 000000000000..2f36a3f6a0ea --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/createOrUpdateRuleV2.json @@ -0,0 +1,41 @@ +{ + "operationId": "OutboundRule_CreateOrUpdate", + "parameters": { + "accountName": "cognitive-account-name", + "api-version": "2026-05-01", + "body": { + "properties": { + "type": "FQDN", + "category": "UserDefined", + "destination": "destination_endpoint", + "status": "Active" + } + }, + "managedNetworkName": "default", + "resourceGroupName": "test-rg", + "ruleName": "rule_name_1", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "CreateOrUpdate OutboundRule", + "responses": { + "200": { + "body": { + "name": "rule_name_1", + "type": "accounts/outboundRules", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default/outboundRules/rule_name_1", + "properties": { + "type": "FQDN", + "category": "UserDefined", + "destination": "destination_endpoint", + "status": "Active" + } + }, + "headers": {} + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/deleteManagedNetworkV2.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/deleteManagedNetworkV2.json new file mode 100644 index 000000000000..602c7990be12 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/deleteManagedNetworkV2.json @@ -0,0 +1,20 @@ +{ + "operationId": "ManagedNetworkSettings_Delete", + "parameters": { + "accountName": "cognitive-account-name", + "api-version": "2026-05-01", + "managedNetworkName": "default", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Delete ManagedNetworkSettings", + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.CognitiveServices/locations/westus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2026-05-01", + "Retry-After": "10" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/deleteRuleV2.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/deleteRuleV2.json new file mode 100644 index 000000000000..f83b894a9006 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/deleteRuleV2.json @@ -0,0 +1,21 @@ +{ + "operationId": "OutboundRule_Delete", + "parameters": { + "accountName": "cognitive-account-name", + "api-version": "2026-05-01", + "managedNetworkName": "default", + "resourceGroupName": "test-rg", + "ruleName": "rule-name", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Delete OutboundRule", + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.CognitiveServices/locations/westus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2026-05-01", + "Retry-After": "10" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/getManagedNetworkV2.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/getManagedNetworkV2.json new file mode 100644 index 000000000000..55d7566b76e5 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/getManagedNetworkV2.json @@ -0,0 +1,39 @@ +{ + "operationId": "ManagedNetworkSettings_Get", + "parameters": { + "accountName": "cognitive-account-name", + "api-version": "2026-05-01", + "managedNetworkName": "default", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Get ManagedNetworkSettings", + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.CognitiveServices/accounts/managedNetworks", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default", + "properties": { + "managedNetwork": { + "firewallPublicIpAddress": "22.22.131.49", + "firewallSku": "Standard", + "isolationMode": "AllowOnlyApprovedOutbound", + "networkId": "00000000-1111-2222-3333-444444444444", + "outboundRules": { + "rule_name_1": { + "type": "FQDN", + "category": "UserDefined", + "destination": "destination_endpoint", + "status": "Active" + } + }, + "provisioningState": "Succeeded" + }, + "provisioningState": "Succeeded" + } + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/getRuleV2.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/getRuleV2.json new file mode 100644 index 000000000000..b1dc41f005ba --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/getRuleV2.json @@ -0,0 +1,28 @@ +{ + "operationId": "OutboundRule_Get", + "parameters": { + "accountName": "cognitive-account-name", + "api-version": "2026-05-01", + "managedNetworkName": "default", + "resourceGroupName": "test-rg", + "ruleName": "name_of_the_fqdn_rule", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Get OutboundRule", + "responses": { + "200": { + "body": { + "name": "rule_name_1", + "type": "accounts/outboundRules", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default/outboundRules/rule_name_1", + "properties": { + "type": "FQDN", + "category": "UserDefined", + "destination": "destination_of_the_fqdn_rule", + "status": "Active" + } + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/listManagedNetworkV2.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/listManagedNetworkV2.json new file mode 100644 index 000000000000..d5b180cafc7a --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/listManagedNetworkV2.json @@ -0,0 +1,43 @@ +{ + "operationId": "ManagedNetworkSettings_List", + "parameters": { + "accountName": "cognitive-account-name", + "api-version": "2026-05-01", + "managedNetworkName": "default", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List ManagedNetworkSettings", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.CognitiveServices/accounts/managedNetworks", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default", + "properties": { + "managedNetwork": { + "firewallPublicIpAddress": "22.22.131.49", + "firewallSku": "Standard", + "isolationMode": "AllowOnlyApprovedOutbound", + "networkId": "00000000-1111-2222-3333-444444444444", + "outboundRules": { + "rule_name_1": { + "type": "FQDN", + "category": "UserDefined", + "destination": "destination_endpoint", + "status": "Active" + } + }, + "provisioningState": "Succeeded" + }, + "provisioningState": "Succeeded" + } + } + ] + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/listRuleV2.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/listRuleV2.json new file mode 100644 index 000000000000..4d78db56bccd --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/listRuleV2.json @@ -0,0 +1,44 @@ +{ + "operationId": "OutboundRule_List", + "parameters": { + "accountName": "cognitive-account-name", + "api-version": "2026-05-01", + "managedNetworkName": "default", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "List OutboundRules", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule_name_1", + "type": "accounts/outboundRules", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default/outboundRules/rule_name_1", + "properties": { + "type": "FQDN", + "category": "Required", + "destination": "destination_of_the_fqdn_rule", + "errorInformation": "Error message", + "status": "Inactive" + } + }, + { + "name": "rule_name_2", + "type": "accounts/outboundRules", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default/outboundRules/rule_name_2", + "properties": { + "type": "FQDN", + "category": "Required", + "destination": "destination_of_the_fqdn_rule", + "errorInformation": "Error message", + "status": "Inactive" + } + } + ] + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/patchManagedNetworkV2.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/patchManagedNetworkV2.json new file mode 100644 index 000000000000..0a017a56665f --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/patchManagedNetworkV2.json @@ -0,0 +1,59 @@ +{ + "operationId": "ManagedNetworkSettings_Patch", + "parameters": { + "accountName": "cognitive-account-name", + "api-version": "2026-05-01", + "body": { + "properties": { + "managedNetwork": { + "firewallSku": "Standard", + "isolationMode": "AllowOnlyApprovedOutbound", + "outboundRules": { + "rule_name_1": { + "type": "FQDN", + "category": "UserDefined", + "destination": "destination_endpoint" + } + } + } + } + }, + "managedNetworkName": "default", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Patch ManagedNetworkSettings", + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.CognitiveServices/accounts/managedNetworks", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default", + "properties": { + "managedNetwork": { + "firewallPublicIpAddress": "22.22.131.49", + "firewallSku": "Standard", + "isolationMode": "AllowOnlyApprovedOutbound", + "networkId": "00000000-1111-2222-3333-444444444444", + "outboundRules": { + "rule_name_1": { + "type": "FQDN", + "category": "UserDefined", + "destination": "destination_endpoint", + "status": "Active" + } + }, + "provisioningState": "Succeeded" + }, + "provisioningState": "Succeeded" + } + }, + "headers": {} + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/postOutboundRulesV2.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/postOutboundRulesV2.json new file mode 100644 index 000000000000..ccfbc1032395 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/postOutboundRulesV2.json @@ -0,0 +1,49 @@ +{ + "operationId": "OutboundRules_Post", + "parameters": { + "accountName": "cognitive-account-name", + "api-version": "2026-05-01", + "body": { + "properties": { + "firewallSku": "Standard", + "isolationMode": "AllowOnlyApprovedOutbound", + "outboundRules": { + "rule_name_1": { + "type": "FQDN", + "category": "UserDefined", + "destination": "destination_endpoint" + } + } + } + }, + "managedNetworkName": "default", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Post OutboundRules", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule_name_1", + "type": "accounts/outboundRules", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/cognitive-account-name/managedNetworks/default/outboundRules/rule_name_1", + "properties": { + "type": "FQDN", + "category": "Required", + "destination": "destination_of_the_fqdn_rule", + "status": "Active" + } + } + ] + }, + "headers": {} + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/provisionManagedNetwork.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/provisionManagedNetwork.json new file mode 100644 index 000000000000..435f0aff4174 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ManagedNetwork/provisionManagedNetwork.json @@ -0,0 +1,24 @@ +{ + "operationId": "ManagedNetworkProvisions_ProvisionManagedNetwork", + "parameters": { + "accountName": "cognitive-account-name", + "api-version": "2026-05-01", + "body": {}, + "managedNetworkName": "default", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Provision ManagedNetwork", + "responses": { + "200": { + "body": { + "status": "Active" + } + }, + "202": { + "headers": { + "Location": "location_url_to_poll_for_status" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PauseDeployment.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PauseDeployment.json new file mode 100644 index 000000000000..e7eef89bdabc --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PauseDeployment.json @@ -0,0 +1,33 @@ +{ + "operationId": "Deployments_Pause", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "deploymentName": "deploymentName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "PauseDeployment", + "responses": { + "200": { + "body": { + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "properties": { + "deploymentState": "Paused", + "model": { + "name": "gpt-4", + "format": "OpenAI", + "version": "0613" + }, + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectCapabilityHost/createOrUpdate.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectCapabilityHost/createOrUpdate.json new file mode 100644 index 000000000000..2a15cb7f9e05 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectCapabilityHost/createOrUpdate.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "capabilityHost": { + "properties": { + "aiServicesConnections": [ + "aoai_connection" + ], + "storageConnections": [ + "blob_connection" + ], + "threadStorageConnections": [ + "aca_connection" + ], + "vectorStoreConnections": [ + "acs_connection" + ] + } + }, + "capabilityHostName": "capabilityHostName", + "projectName": "project-1", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "capabilityHostName", + "type": "Microsoft.CognitiveServices/accounts/projects/capabilityHosts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/capabilityHosts/capabilityHostName", + "properties": { + "aiServicesConnections": [ + "aoai_connection" + ], + "provisioningState": "Succeeded", + "storageConnections": [ + "blob_connection" + ], + "threadStorageConnections": [ + "aca_connection" + ], + "vectorStoreConnections": [ + "acs_connection" + ] + } + }, + "headers": {} + }, + "201": { + "body": { + "name": "capabilityHostName", + "type": "Microsoft.CognitiveServices/accounts/projects/capabilityHosts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/capabilityHosts/capabilityHostName", + "properties": { + "aiServicesConnections": [ + "aoai_connection" + ], + "provisioningState": "Succeeded", + "storageConnections": [ + "blob_connection" + ], + "threadStorageConnections": [ + "aca_connection" + ], + "vectorStoreConnections": [ + "acs_connection" + ] + } + }, + "headers": { + "Location": "example_location" + } + } + }, + "operationId": "ProjectCapabilityHosts_CreateOrUpdate", + "title": "CreateOrUpdate Project CapabilityHost." +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectCapabilityHost/delete.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectCapabilityHost/delete.json new file mode 100644 index 000000000000..40ecb4ee9cc5 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectCapabilityHost/delete.json @@ -0,0 +1,20 @@ +{ + "operationId": "ProjectCapabilityHosts_Delete", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "capabilityHostName": "capabilityHostName", + "projectName": "project-1", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Delete Project CapabilityHost.", + "responses": { + "202": { + "headers": { + "Location": "location_header_to_poll" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectCapabilityHost/get.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectCapabilityHost/get.json new file mode 100644 index 000000000000..5b1f59643d4c --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectCapabilityHost/get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "capabilityHostName": "capabilityHostName", + "projectName": "project-1", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "capabilityHostName", + "type": "Microsoft.CognitiveServices/accounts/projects/capabilityHosts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/capabilityHosts/capabilityHostName", + "properties": { + "aiServicesConnections": [ + "aoai_connection" + ], + "provisioningState": "Succeeded", + "storageConnections": [ + "blob_connection" + ], + "threadStorageConnections": [ + "aca_connection" + ], + "vectorStoreConnections": [ + "acs_connection" + ] + } + }, + "headers": {} + } + }, + "operationId": "ProjectCapabilityHosts_Get", + "title": "Get Project CapabilityHost." +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectCapabilityHost/list.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectCapabilityHost/list.json new file mode 100644 index 000000000000..2e3e622f0c82 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectCapabilityHost/list.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "projectName": "project-1", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "capabilityHostName", + "type": "Microsoft.CognitiveServices/accounts/projects/capabilityHosts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/capabilityHosts/capabilityHostName", + "properties": { + "aiServicesConnections": [ + "aoai_connection" + ], + "provisioningState": "Succeeded", + "storageConnections": [ + "blob_connection" + ], + "threadStorageConnections": [ + "aca_connection" + ], + "vectorStoreConnections": [ + "acs_connection" + ] + } + } + ] + }, + "headers": {} + } + }, + "operationId": "ProjectCapabilityHosts_List", + "title": "List Project CapabilityHosts." +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectConnection/create.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectConnection/create.json new file mode 100644 index 000000000000..ce6d3b413571 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectConnection/create.json @@ -0,0 +1,35 @@ +{ + "operationId": "ProjectConnections_Create", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "connection": { + "properties": { + "authType": "None", + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[target url]" + } + }, + "connectionName": "connection-1", + "projectName": "project-1", + "resourceGroupName": "resourceGroup-1", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "CreateProjectConnection", + "responses": { + "200": { + "body": { + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/projects/connections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/connections/connection-1", + "properties": { + "authType": "None", + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[target url]" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectConnection/delete.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectConnection/delete.json new file mode 100644 index 000000000000..6722b8bd121d --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectConnection/delete.json @@ -0,0 +1,16 @@ +{ + "operationId": "ProjectConnections_Delete", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "connectionName": "connection-1", + "projectName": "project-1", + "resourceGroupName": "resourceGroup-1", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "DeleteProjectConnection", + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectConnection/get.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectConnection/get.json new file mode 100644 index 000000000000..04f7fa00aef2 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectConnection/get.json @@ -0,0 +1,27 @@ +{ + "operationId": "ProjectConnections_Get", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "connectionName": "connection-1", + "projectName": "project-1", + "resourceGroupName": "resourceGroup-1", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "GetProjectConnection", + "responses": { + "200": { + "body": { + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/projects/connections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/connections/connection-1", + "properties": { + "authType": "None", + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[target url]" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectConnection/list.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectConnection/list.json new file mode 100644 index 000000000000..bda2f1585fe4 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectConnection/list.json @@ -0,0 +1,42 @@ +{ + "operationId": "ProjectConnections_List", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "category": "ContainerRegistry", + "projectName": "project-1", + "resourceGroupName": "resourceGroup-1", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "target": "[target url]" + }, + "title": "ListProjectConnection", + "responses": { + "200": { + "body": { + "value": [ + { + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/projects/connections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/connections/connection-1", + "properties": { + "authType": "PAT", + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "[target url]" + } + }, + { + "name": "connection-2", + "type": "Microsoft.CognitiveServices/accounts/projects/connections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/connections/connection-2", + "properties": { + "authType": "PAT", + "category": "ContainerRegistry", + "target": "[target url]" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectConnection/update.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectConnection/update.json new file mode 100644 index 000000000000..abd64bf5f239 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ProjectConnection/update.json @@ -0,0 +1,42 @@ +{ + "operationId": "ProjectConnections_Update", + "parameters": { + "accountName": "account-1", + "api-version": "2026-05-01", + "connection": { + "properties": { + "authType": "AccessKey", + "category": "ADLSGen2", + "credentials": { + "accessKeyId": "some_string", + "secretAccessKey": "some_string" + }, + "expiryTime": "2020-01-01T00:00:00Z", + "metadata": {}, + "target": "some_string" + } + }, + "connectionName": "connection-1", + "projectName": "project-1", + "resourceGroupName": "test-rg", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "UpdateProjectConnection", + "responses": { + "200": { + "body": { + "name": "connection-1", + "type": "Microsoft.CognitiveServices/accounts/projects/connections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.CognitiveServices/accounts/account-1/projects/project-1/connections/connection-1", + "properties": { + "authType": "AccessKey", + "category": "ADLSGen2", + "expiryTime": "2020-01-01T00:00:00Z", + "metadata": {}, + "target": "some_string" + } + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PurgeDeletedAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PurgeDeletedAccount.json new file mode 100644 index 000000000000..88958409b3dd --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PurgeDeletedAccount.json @@ -0,0 +1,20 @@ +{ + "operationId": "DeletedAccounts_Purge", + "parameters": { + "accountName": "PropTest01", + "api-version": "2026-05-01", + "location": "westus", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Delete Account", + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutCommitmentPlan.json new file mode 100644 index 000000000000..65698fc13a0e --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutCommitmentPlan.json @@ -0,0 +1,53 @@ +{ + "operationId": "CommitmentPlans_CreateOrUpdate", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "commitmentPlan": { + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "Speech2Text" + } + }, + "commitmentPlanName": "commitmentPlanName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "PutCommitmentPlan", + "responses": { + "200": { + "body": { + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/accounts/commitmentPlans", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/commitmentPlans/commitmentPlanName", + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "Speech2Text" + } + } + }, + "201": { + "body": { + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/accounts/commitmentPlans", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/commitmentPlans/commitmentPlanName", + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "Speech2Text" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutDefenderForAISetting.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutDefenderForAISetting.json new file mode 100644 index 000000000000..c8cd2e1928f9 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutDefenderForAISetting.json @@ -0,0 +1,56 @@ +{ + "operationId": "DefenderForAISettings_CreateOrUpdate", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "defenderForAISettingName": "Default", + "defenderForAISettings": { + "properties": { + "state": "Enabled" + } + }, + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "PutDefenderForAISetting", + "responses": { + "200": { + "body": { + "name": "Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdAt": "2022-04-03T04:41:33.937Z", + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "name": "Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdAt": "2022-04-03T04:41:33.937Z", + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutDeployment.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutDeployment.json new file mode 100644 index 000000000000..a1f5324bf259 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutDeployment.json @@ -0,0 +1,70 @@ +{ + "operationId": "Deployments_CreateOrUpdate", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "deployment": { + "properties": { + "deploymentState": "Running", + "model": { + "name": "ada", + "format": "OpenAI", + "version": "1" + }, + "serviceTier": "Priority" + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + }, + "deploymentName": "deploymentName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "PutDeployment", + "responses": { + "200": { + "body": { + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "properties": { + "deploymentState": "Running", + "model": { + "name": "ada", + "format": "OpenAI", + "version": "1" + }, + "provisioningState": "Succeeded", + "serviceTier": "Priority" + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + } + }, + "201": { + "body": { + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "properties": { + "deploymentState": "Running", + "model": { + "name": "ada", + "format": "OpenAI", + "version": "1" + }, + "provisioningState": "Accepted", + "serviceTier": "Priority" + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutEncryptionScope.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutEncryptionScope.json new file mode 100644 index 000000000000..c30aec04f355 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutEncryptionScope.json @@ -0,0 +1,79 @@ +{ + "operationId": "EncryptionScopes_CreateOrUpdate", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "encryptionScope": { + "properties": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "identityClientId": "00000000-0000-0000-0000-000000000000", + "keyName": "DevKeyWestUS2", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95" + }, + "state": "Enabled" + } + }, + "encryptionScopeName": "encryptionScopeName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "PutEncryptionScope", + "responses": { + "200": { + "body": { + "name": "encryptionScopeName", + "type": "Microsoft.CognitiveServices/accounts/encryptionScopes", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName", + "properties": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "identityClientId": "00000000-0000-0000-0000-000000000000", + "keyName": "DevKeyWestUS2", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95" + }, + "provisioningState": "Succeeded", + "state": "Enabled" + }, + "systemData": { + "createdAt": "2023-06-08T06:35:08.0662558Z", + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2023-06-08T06:35:08.0662558Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "name": "encryptionScopeName", + "type": "Microsoft.CognitiveServices/accounts/encryptionScopes", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName", + "properties": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": { + "identityClientId": "00000000-0000-0000-0000-000000000000", + "keyName": "DevKeyWestUS2", + "keyVaultUri": "https://devkvwestus2.vault.azure.net/", + "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95" + }, + "provisioningState": "Succeeded", + "state": "Enabled" + }, + "systemData": { + "createdAt": "2023-06-08T06:35:08.0662558Z", + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2023-06-08T06:35:08.0662558Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutPrivateEndpointConnection.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutPrivateEndpointConnection.json new file mode 100644 index 000000000000..adc80476beec --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutPrivateEndpointConnection.json @@ -0,0 +1,56 @@ +{ + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "parameters": { + "accountName": "sto9699", + "api-version": "2026-05-01", + "monitor": "true", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "description": "Auto-Approved", + "status": "Approved" + } + } + }, + "resourceGroupName": "res7687", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "PutPrivateEndpointConnection", + "responses": { + "200": { + "body": { + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "description": "Auto-Approved", + "actionsRequired": "None", + "status": "Approved" + } + } + } + }, + "202": { + "body": { + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.CognitiveServices/accounts/privateEndpointConnections", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.CognitiveServices/accounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "description": "Auto-Approved", + "actionsRequired": "None", + "status": "Approved" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiBlocklist.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiBlocklist.json new file mode 100644 index 000000000000..f20a8d62561d --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiBlocklist.json @@ -0,0 +1,36 @@ +{ + "operationId": "RaiBlocklists_CreateOrUpdate", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiBlocklist": { + "properties": { + "description": "Basic blocklist description" + } + }, + "raiBlocklistName": "raiBlocklistName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "PutRaiBlocklist", + "responses": { + "200": { + "body": { + "name": "raiBlocklistName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName", + "properties": { + "description": "Basic blocklist description" + } + } + }, + "201": { + "body": { + "name": "raiBlocklistName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName", + "properties": { + "description": "Basic blocklist description" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiBlocklistItem.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiBlocklistItem.json new file mode 100644 index 000000000000..4c0979542c79 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiBlocklistItem.json @@ -0,0 +1,40 @@ +{ + "operationId": "RaiBlocklistItems_CreateOrUpdate", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiBlocklistItem": { + "properties": { + "isRegex": false, + "pattern": "Pattern To Block" + } + }, + "raiBlocklistItemName": "raiBlocklistItemName", + "raiBlocklistName": "raiBlocklistName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "PutRaiBlocklistItem", + "responses": { + "200": { + "body": { + "name": "raiBlocklistItemName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName", + "properties": { + "isRegex": false, + "pattern": "Pattern To Block" + } + } + }, + "201": { + "body": { + "name": "raiBlocklistItemName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName/raiBlocklistItems/raiBlocklistItemName", + "properties": { + "isRegex": false, + "pattern": "Pattern To Block" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiExternalSafetyProvider.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiExternalSafetyProvider.json new file mode 100644 index 000000000000..786b164f6814 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiExternalSafetyProvider.json @@ -0,0 +1,53 @@ +{ + "operationId": "RaiExternalSafetyProvider_CreateOrUpdate", + "parameters": { + "api-version": "2026-05-01", + "safetyProvider": { + "properties": { + "keyVaultUri": "https://example.vault.azure.net", + "managedIdentity": "00000000-0000-0000-0000-000000000000", + "mode": "sync", + "providerId": "00000000-0000-0000-0000-000000000000", + "providerName": "safetyProviderName", + "secretName": "mySecretName", + "url": "https://example.webhook.endpoint" + } + }, + "safetyProviderName": "safetyProviderName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "PutRaiExternalSafetyProvider", + "responses": { + "200": { + "body": { + "name": "safetyProviderName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/raiExternalSafetyProviders/safetyProviderName", + "properties": { + "createdAt": "2025-07-01T00:00:00Z", + "keyVaultUri": "https://example.vault.azure.net", + "lastModifiedAt": "2025-07-02T00:00:00Z", + "managedIdentity": "00000000-0000-0000-0000-000000000000", + "mode": "sync", + "providerId": "00000000-0000-0000-0000-000000000000", + "providerName": "safetyProviderName", + "secretName": "mySecretName", + "url": "https://example.webhook.endpoint" + } + } + }, + "201": { + "body": { + "name": "safetyProviderName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/raiExternalSafetyProviders/safetyProviderName", + "properties": { + "createdAt": "2025-07-01T00:00:00Z", + "lastModifiedAt": "2025-07-02T00:00:00Z", + "mode": "sync", + "providerId": "00000000-0000-0000-0000-000000000000", + "providerName": "safetyProviderName", + "url": "https://example.webhook.endpoint" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiPolicy.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiPolicy.json new file mode 100644 index 000000000000..004bb8a5f41c --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiPolicy.json @@ -0,0 +1,285 @@ +{ + "operationId": "RaiPolicies_CreateOrUpdate", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiPolicy": { + "properties": { + "basePolicyName": "Microsoft.Default", + "contentFilters": [ + { + "name": "Hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Jailbreak", + "blocking": true, + "enabled": true, + "source": "Prompt" + }, + { + "name": "Protected Material Text", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Protected Material Code", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Profanity", + "blocking": true, + "enabled": true, + "source": "Prompt" + } + ], + "mode": "Asynchronous_filter" + } + }, + "raiPolicyName": "raiPolicyName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "PutRaiPolicy", + "responses": { + "200": { + "body": { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "contentFilters": [ + { + "name": "Hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Jailbreak", + "blocking": true, + "enabled": true, + "source": "Prompt" + }, + { + "name": "Protected Material Text", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Protected Material Code", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Profanity", + "blocking": true, + "enabled": true, + "source": "Prompt" + } + ], + "mode": "Asynchronous_filter" + } + } + }, + "201": { + "body": { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "contentFilters": [ + { + "name": "Hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Jailbreak", + "blocking": true, + "enabled": true, + "source": "Prompt" + }, + { + "name": "Protected Material Text", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Protected Material Code", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Profanity", + "blocking": true, + "enabled": true, + "source": "Prompt" + } + ], + "mode": "Asynchronous_filter" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiToolLabel.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiToolLabel.json new file mode 100644 index 000000000000..a027e59044e0 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiToolLabel.json @@ -0,0 +1,95 @@ +{ + "operationId": "RaiToolLabels_CreateOrUpdate", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiToolConnectionName": "Web_Search", + "raiToolLabel": { + "properties": { + "accountScope": { + "labelValues": { + "confidentiality": "low" + } + }, + "projectScopes": [ + { + "labelValues": { + "confidentiality": "low" + }, + "project": "test-project" + }, + { + "labelValues": { + "confidentiality": "low" + }, + "project": "sample-project" + } + ], + "toolConnectionName": "Web_Search" + } + }, + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "PutRaiToolLabel", + "responses": { + "200": { + "body": { + "name": "Web_Search", + "type": "Microsoft.CognitiveServices/accounts/raiToolLabels", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiToolLabels/Web_Search", + "properties": { + "accountScope": { + "labelValues": { + "confidentiality": "low" + } + }, + "projectScopes": [ + { + "labelValues": { + "confidentiality": "low" + }, + "project": "test-project" + }, + { + "labelValues": { + "confidentiality": "low" + }, + "project": "sample-project" + } + ], + "toolConnectionName": "Web_Search" + } + } + }, + "201": { + "body": { + "name": "Web_Search", + "type": "Microsoft.CognitiveServices/accounts/raiToolLabels", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiToolLabels/Web_Search", + "properties": { + "accountScope": { + "labelValues": { + "confidentiality": "low" + } + }, + "projectScopes": [ + { + "labelValues": { + "confidentiality": "low" + }, + "project": "test-project" + }, + { + "labelValues": { + "confidentiality": "low" + }, + "project": "sample-project" + } + ], + "toolConnectionName": "Web_Search" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiTopic.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiTopic.json new file mode 100644 index 000000000000..76d186b2f97a --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutRaiTopic.json @@ -0,0 +1,50 @@ +{ + "operationId": "RaiTopics_CreateOrUpdate", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiTopic": { + "properties": { + "description": "This is a sample topic.", + "sampleBlobUrl": "https://example.blob.core.windows.net/sampleblob", + "topicName": "raiTopicName" + } + }, + "raiTopicName": "raiTopicName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "PutRaiTopic", + "responses": { + "200": { + "body": { + "name": "raiTopicName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiTopics/raiTopicName", + "properties": { + "description": "This is a sample topic.", + "createdAt": "2025-07-01T00:00:00Z", + "lastModifiedAt": "2025-07-02T00:00:00Z", + "sampleBlobUrl": "https://example.blob.core.windows.net/sampleblob", + "status": "Training", + "topicId": "00000000-0000-0000-0000-000000000000", + "topicName": "raiTopicName" + } + } + }, + "201": { + "body": { + "name": "raiTopicName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiTopics/raiTopicName", + "properties": { + "description": "This is a sample topic.", + "createdAt": "2025-07-01T00:00:00Z", + "lastModifiedAt": "2025-07-02T00:00:00Z", + "sampleBlobUrl": "https://example.blob.core.windows.net/sampleblob", + "status": "Training", + "topicId": "00000000-0000-0000-0000-000000000000", + "topicName": "raiTopicName" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutSubscriptionRaiPolicy.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutSubscriptionRaiPolicy.json new file mode 100644 index 000000000000..49bed5283fc1 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/PutSubscriptionRaiPolicy.json @@ -0,0 +1,285 @@ +{ + "operationId": "SubscriptionRaiPolicy_CreateOrUpdate", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "raiPolicy": { + "properties": { + "basePolicyName": "Microsoft.Default", + "contentFilters": [ + { + "name": "Hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Jailbreak", + "blocking": true, + "enabled": true, + "source": "Prompt" + }, + { + "name": "Protected Material Text", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Protected Material Code", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Profanity", + "blocking": true, + "enabled": true, + "source": "Prompt" + } + ], + "mode": "Asynchronous_filter" + } + }, + "raiPolicyName": "raiPolicyName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "PutRaiPolicy", + "responses": { + "200": { + "body": { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "contentFilters": [ + { + "name": "Hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Jailbreak", + "blocking": true, + "enabled": true, + "source": "Prompt" + }, + { + "name": "Protected Material Text", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Protected Material Code", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Profanity", + "blocking": true, + "enabled": true, + "source": "Prompt" + } + ], + "mode": "Asynchronous_filter" + } + } + }, + "201": { + "body": { + "name": "raiPolicyName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiPolicies/raiPolicyName", + "properties": { + "basePolicyName": "Microsoft.Default", + "contentFilters": [ + { + "name": "Hate", + "blocking": false, + "enabled": false, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Hate", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Sexual", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "High", + "source": "Prompt" + }, + { + "name": "Selfharm", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Prompt" + }, + { + "name": "Violence", + "blocking": true, + "enabled": true, + "severityThreshold": "Medium", + "source": "Completion" + }, + { + "name": "Jailbreak", + "blocking": true, + "enabled": true, + "source": "Prompt" + }, + { + "name": "Protected Material Text", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Protected Material Code", + "blocking": true, + "enabled": true, + "source": "Completion" + }, + { + "name": "Profanity", + "blocking": true, + "enabled": true, + "source": "Prompt" + } + ], + "mode": "Asynchronous_filter" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ReconcileNetworkSecurityPerimeterConfigurations.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ReconcileNetworkSecurityPerimeterConfigurations.json new file mode 100644 index 000000000000..7d48fd832267 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ReconcileNetworkSecurityPerimeterConfigurations.json @@ -0,0 +1,53 @@ +{ + "operationId": "NetworkSecurityPerimeterConfigurations_Reconcile", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "nspConfigurationName": "NSPConfigurationName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "ReconcileNetworkSecurityPerimeterConfigurations", + "responses": { + "200": { + "body": { + "name": "networkSecurityPerimeterConfigurationName", + "type": "Microsoft.CognitiveServices/accounts/networkSecurityPerimeterConfigurations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/networkSecurityPerimeterConfigurations/config1", + "properties": { + "networkSecurityPerimeter": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.Network/networkSecurityPerimeters/perimeter", + "location": "East US", + "perimeterGuid": "00000000-0000-0000-0000-000000000000" + }, + "profile": { + "name": "profileName", + "accessRules": [ + { + "name": "ruleName", + "properties": { + "addressPrefixes": [ + "148.0.0.0/8", + "152.4.6.0/24" + ], + "direction": "Inbound" + } + } + ], + "accessRulesVersion": 1 + }, + "provisioningState": "Succeeded", + "resourceAssociation": { + "name": "associationName", + "accessMode": "Enforced" + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/RegenerateKey.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/RegenerateKey.json new file mode 100644 index 000000000000..f43fd7148f7e --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/RegenerateKey.json @@ -0,0 +1,21 @@ +{ + "operationId": "Accounts_RegenerateKey", + "parameters": { + "accountName": "myAccount", + "api-version": "2026-05-01", + "parameters": { + "keyName": "Key2" + }, + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Regenerate Keys", + "responses": { + "200": { + "body": { + "key1": "KEY1", + "key2": "KEY2" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ResumeDeployment.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ResumeDeployment.json new file mode 100644 index 000000000000..127e7ba69ca8 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/ResumeDeployment.json @@ -0,0 +1,33 @@ +{ + "operationId": "Deployments_Resume", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "deploymentName": "deploymentName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "ResumeDeployment", + "responses": { + "200": { + "body": { + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "properties": { + "deploymentState": "Running", + "model": { + "name": "gpt-4", + "format": "OpenAI", + "version": "0613" + }, + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/TestRaiExternalSafetyProvider.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/TestRaiExternalSafetyProvider.json new file mode 100644 index 000000000000..e426d2b4af60 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/TestRaiExternalSafetyProvider.json @@ -0,0 +1,62 @@ +{ + "operationId": "TestRaiExternalSafetyProvider_CreateOrUpdate", + "parameters": { + "accountName": "myCognitiveAccount", + "api-version": "2026-05-01", + "resourceGroupName": "myResourceGroup", + "safetyProvider": { + "properties": { + "keyVaultUri": "https://contoso-vault.vault.azure.net/", + "managedIdentity": "f3b9c2e7-4aad-4b1f-9d9c-9e9b1e9b1f9b", + "mode": "sync", + "providerId": "00000000-0000-0000-0000-000000000000", + "providerName": "safetyProviderName", + "secretName": "safety-provider-secret", + "url": "https://example-safety-provider.contoso.com/webhook" + } + }, + "safetyProviderName": "mySafetyProvider", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "TestRaiExternalSafetyProvider", + "responses": { + "200": { + "body": { + "name": "mySafetyProvider", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/raiExternalSafetyProviders/mySafetyProvider", + "properties": { + "keyVaultUri": "https://contoso-vault.vault.azure.net/", + "managedIdentity": "f3b9c2e7-4aad-4b1f-9d9c-9e9b1e9b1f9b", + "mode": "sync", + "providerId": "00000000-0000-0000-0000-000000000000", + "providerName": "safetyProviderName", + "secretName": "safety-provider-secret", + "url": "https://example-safety-provider.contoso.com/webhook" + } + } + }, + "201": { + "body": { + "name": "mySafetyProvider", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/raiExternalSafetyProviders/mySafetyProvider", + "properties": { + "keyVaultUri": "https://contoso-vault.vault.azure.net/", + "managedIdentity": "f3b9c2e7-4aad-4b1f-9d9c-9e9b1e9b1f9b", + "mode": "sync", + "providerId": "00000000-0000-0000-0000-000000000000", + "providerName": "safetyProviderName", + "secretName": "safety-provider-secret", + "url": "https://example-safety-provider.contoso.com/webhook" + } + } + }, + "default": { + "body": { + "error": { + "code": "BadRequest", + "message": "The request is invalid." + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateAccount.json new file mode 100644 index 000000000000..dd268e68400c --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateAccount.json @@ -0,0 +1,60 @@ +{ + "operationId": "Accounts_Update", + "parameters": { + "account": { + "location": "global", + "sku": { + "name": "S2" + } + }, + "accountName": "bingSearch", + "api-version": "2026-05-01", + "resourceGroupName": "bvttest", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Update Account", + "responses": { + "200": { + "body": { + "name": "bingSearch", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch", + "kind": "Bing.Search", + "location": "global", + "properties": { + "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S2" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-06-01", + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "202": { + "body": { + "name": "bingSearch", + "type": "Microsoft.CognitiveServices/accounts", + "etag": "W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch", + "kind": "Bing.Search", + "location": "global", + "properties": { + "endpoint": "https://api.cognitive.microsoft.com/bing/v5.0", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S2" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-06-01", + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateDefenderForAISetting.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateDefenderForAISetting.json new file mode 100644 index 000000000000..693196b42dbe --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateDefenderForAISetting.json @@ -0,0 +1,37 @@ +{ + "operationId": "DefenderForAISettings_Update", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "defenderForAISettingName": "Default", + "defenderForAISettings": { + "properties": { + "state": "Enabled" + } + }, + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "UpdateDefenderForAISetting", + "responses": { + "200": { + "body": { + "name": "Default", + "type": "Microsoft.CognitiveServices/accounts/defenderForAISettings", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/defenderForAISettings/Default", + "properties": { + "state": "Enabled" + }, + "systemData": { + "createdAt": "2022-04-03T04:41:33.937Z", + "createdBy": "xxx@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2022-04-03T04:41:33.937Z", + "lastModifiedBy": "xxx@microsoft.com", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateDeployment.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateDeployment.json new file mode 100644 index 000000000000..c6ef4de62505 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateDeployment.json @@ -0,0 +1,45 @@ +{ + "operationId": "Deployments_Update", + "parameters": { + "accountName": "accountName", + "api-version": "2026-05-01", + "deployment": { + "sku": { + "name": "Standard", + "capacity": 1 + } + }, + "deploymentName": "deploymentName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "UpdateDeployment", + "responses": { + "200": { + "body": { + "name": "deploymentName", + "type": "Microsoft.CognitiveServices/accounts/deployments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName", + "properties": { + "deploymentState": "Paused", + "model": { + "name": "ada", + "format": "OpenAI", + "version": "1" + }, + "provisioningState": "Succeeded", + "serviceTier": "Priority" + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateProjects.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateProjects.json new file mode 100644 index 000000000000..18f586946dbc --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateProjects.json @@ -0,0 +1,65 @@ +{ + "operationId": "Projects_Update", + "parameters": { + "accountName": "bingSearch", + "api-version": "2026-05-01", + "project": { + "location": "global", + "properties": { + "description": "new description." + } + }, + "projectName": "projectName", + "resourceGroupName": "bvttest", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Update Project", + "responses": { + "200": { + "body": { + "name": "projectName", + "type": "Microsoft.CognitiveServices/accounts/projects", + "etag": "W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch/projects/projectName", + "location": "global", + "properties": { + "description": "new description.", + "displayName": "myProject", + "endpoints": { + "OpenAI Dall-E API": "https://customSubDomainName.openai.azure.com/", + "OpenAI Language Model Instance API": "https://customSubDomainName.openai.azure.com/" + }, + "isDefault": false, + "provisioningState": "Succeeded" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-06-01", + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "202": { + "body": { + "name": "projectName", + "type": "Microsoft.CognitiveServices/accounts/projects", + "etag": "W/\"datetime'2017-04-10T07%3A46%3A21.5618831Z'\"", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/bvttest/providers/Microsoft.CognitiveServices/accounts/bingSearch/projects/projectName", + "location": "global", + "properties": { + "description": "new description.", + "displayName": "myProject", + "endpoints": { + "OpenAI Dall-E API": "https://customSubDomainName.openai.azure.com/", + "OpenAI Language Model Instance API": "https://customSubDomainName.openai.azure.com/" + }, + "isDefault": false, + "provisioningState": "Succeeded" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/global/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-06-01", + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateQuotaTier.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateQuotaTier.json new file mode 100644 index 000000000000..f74de5a31a4d --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateQuotaTier.json @@ -0,0 +1,28 @@ +{ + "operationId": "QuotaTiers_Update", + "parameters": { + "default": "default", + "api-version": "2026-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tier": { + "properties": { + "tierUpgradePolicy": "NoAutoUpgrade" + } + } + }, + "title": "Update the quota tier resource for a subscription", + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.CognitiveServices/quotaTiers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/quotaTiers/default", + "properties": { + "assignmentDate": "2025-06-09T18:13:29.389Z", + "currentTierName": "Free-Tier", + "tierUpgradePolicy": "NoAutoUpgrade" + } + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateSharedCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateSharedCommitmentPlan.json new file mode 100644 index 000000000000..3770717504cd --- /dev/null +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2026-05-01/examples/UpdateSharedCommitmentPlan.json @@ -0,0 +1,46 @@ +{ + "operationId": "CommitmentPlans_UpdatePlan", + "parameters": { + "api-version": "2026-05-01", + "commitmentPlan": { + "tags": { + "name": "value" + } + }, + "commitmentPlanName": "commitmentPlanName", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "title": "Create Commitment Plan", + "responses": { + "200": { + "body": { + "name": "commitmentPlanName", + "type": "Microsoft.CognitiveServices/commitmentPlans", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/commitmentPlans/commitmentPlanName", + "kind": "SpeechServices", + "location": "West US", + "properties": { + "autoRenew": true, + "current": { + "tier": "T1" + }, + "hostingModel": "Web", + "planType": "STT", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "S0" + }, + "tags": { + "name": "value" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/readme.md b/specification/cognitiveservices/resource-manager/readme.md index 4f385b56a759..2c5338d8654d 100644 --- a/specification/cognitiveservices/resource-manager/readme.md +++ b/specification/cognitiveservices/resource-manager/readme.md @@ -30,9 +30,101 @@ These are the global settings for the CognitiveServices API. ```yaml openapi-type: arm -tag: package-2026-03-15-preview +tag: package-2026-05-01 ``` +### Tag: package-2026-05-01 + +These settings apply only when `--tag=package-2026-05-01` is specified on the command line. + +```yaml $(tag) == 'package-2026-05-01' +input-file: + - Microsoft.CognitiveServices/stable/2026-05-01/cognitiveservices.json +suppressions: + - code: ArmResourcePropertiesBag + reason: This API is copied from Machine Learning Services RP where this behavior is already established. + where: + - $.definitions.OutboundRuleBasicResource + - code: AvoidAdditionalProperties + reason: This API is copied from Machine Learning Services RP where this behavior is already established. + where: + - $.definitions.ManagedNetworkSettings.properties.outboundRules + - code: ProvisioningStateSpecifiedForLROPut + reason: This API is copied from Machine Learning Services RP where this behavior is already established. + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/managedNetworks/{managedNetworkName}/outboundRules/{ruleName}"].put + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/managedNetworks/{managedNetworkName}"].put + - code: PutResponseCodes + reason: This API is copied from Machine Learning Services RP where it is already established and in use. + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/managedNetworks/{managedNetworkName}/outboundRules/{ruleName}"].put + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/managedNetworks/{managedNetworkName}"].put + - code: PutResponseCodes + reason: This is existing behavior in all other APIs and already in stable version, will keep the same. + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"].put + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/connections/{connectionName}"].put + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/connections/{connectionName}"].put + - code: PatchResponseCodes + reason: This is existing behavior in all other APIs and already in stable version, will keep the same. + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"].patch + - code: PatchBodyParametersSchema + reason: this is a required field for in a optional property this experience exist in other stable schemas as well. + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/connections/{connectionName}"].patch.parameters[5].schema.properties.properties + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"].patch.parameters[3].schema.properties.properties + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"].patch.parameters[3].schema.properties.sku + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/connections/{connectionName}"].patch.parameters[6].schema.properties.properties + - code: GuidUsage + reason: Approved to be suppressed in AML swagger. + where: + - $.definitions.ConnectionOAuth2.properties.clientId.format + - code: DeleteResponseCodes + reason: Behavior is align with other existing API for this RP + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"].delete + - code: AvoidAdditionalProperties + reason: Approved to be suppressed in AML swagger + where: + - $.definitions.ConnectionPropertiesV2.properties.metadata + - $.definitions.CustomKeys.properties.keys + - code: LroLocationHeader + reason: Align with existing API behavior in other APIs + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"].put.responses.202 + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"].patch.responses.202 + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}"].delete.responses.202 + - code: AvoidAdditionalProperties + reason: Same as existing account resource, trying to have the same behavior + where: + - $.definitions.ProjectProperties.properties.endpoints + - code: AvoidAdditionalProperties + reason: Provide customers ability to assign customize labels to rules. + where: + - $.definitions.RaiToolLabelProperties.properties.accountScope.properties.labelValues + - $.definitions.RaiToolLabelProperties.properties.projectScopes.items.properties.labelValues + - $.definitions.RaiIfcRuleProperties.properties.conditions + - code: AvoidAdditionalProperties + reason: Provide customers ability to define custom conditions for when a rule is activated. + where: + - $.definitions.RaiIfcRuleProperties.properties.conditions + - code: TopLevelResourcesListByResourceGroup + reason: These are subscription level resources and are modeled after the RaiPolicy List operation + where: + - $.definitions.RaiExternalSafetyProvider + - $.definitions.RaiExternalSafetyProviderSchema + - code: ResourceNameRestriction + reason: Parameter exists in previous API versions without pattern, cannot add now without breaking change. + from: cognitiveservices.json + - code: ParametersSchemaAsTypeObject + reason: Backend requires array type for bulk operations since 2024-04-01 API. Changing to object would be a breaking change. + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/addRaiBlocklistItems"].post.parameters[5].schema.type + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists/{raiBlocklistName}/deleteRaiBlocklistItems"].post.parameters[5].schema.type +``` + + ### Tag: package-2026-03-15-preview These settings apply only when `--tag=package-2026-03-15-preview` is specified on the command line. From ac3515b6711e9d76ce8a3c8b84663428404385f0 Mon Sep 17 00:00:00 2001 From: Bernd Verst Date: Tue, 2 Jun 2026 10:02:18 -0700 Subject: [PATCH 09/22] DurableTask: refactor main.tsp into per-resource files and add 2026-05-01-preview API version (#43673) Adds transparentDataEncryptions resource type, capabilities on TaskHubs, and managed identity support on Schedulers (plus a restart action). Existing API versions and model names are preserved as-is. Co-authored-by: Bernd Verst Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../2026-05-01-preview/Operations_List.json | 36 + ...ointConnections_Create_MaximumSet_Gen.json | 84 + ...ointConnections_Delete_MaximumSet_Gen.json | 19 + ...ndpointConnections_Get_MaximumSet_Gen.json | 42 + ...dpointConnections_List_MaximumSet_Gen.json | 46 + .../PrivateEndpointConnections_Update.json | 54 + ...ivateLinkResources_Get_MaximumSet_Gen.json | 37 + ...vateLinkResources_List_MaximumSet_Gen.json | 41 + ...licies_CreateOrReplace_MaximumSet_Gen.json | 83 + ...tentionPolicies_Delete_MaximumSet_Gen.json | 19 + .../RetentionPolicies_Get_MaximumSet_Gen.json | 40 + ...licies_ListByScheduler_MaximumSet_Gen.json | 44 + ...tentionPolicies_Update_MaximumSet_Gen.json | 65 + .../Schedulers_CreateOrUpdate.json | 106 + .../2026-05-01-preview/Schedulers_Delete.json | 18 + .../2026-05-01-preview/Schedulers_Get.json | 46 + .../Schedulers_ListByResourceGroup.json | 50 + .../Schedulers_ListBySubscription.json | 49 + .../Schedulers_Restart.json | 13 + .../2026-05-01-preview/Schedulers_Update.json | 70 + .../TaskHubs_CreateOrUpdate.json | 64 + .../2026-05-01-preview/TaskHubs_Delete.json | 19 + .../2026-05-01-preview/TaskHubs_Get.json | 32 + .../TaskHubs_ListByScheduler.json | 36 + ...ptions_CreateOrReplace_MaximumSet_Gen.json | 61 + ...DataEncryptions_Delete_MaximumSet_Gen.json | 18 + ...entDataEncryptions_Get_MaximumSet_Gen.json | 32 + ...ptions_ListByScheduler_MaximumSet_Gen.json | 37 + .../DurableTask.Management/main.tsp | 290 +- .../retentionpolicy.tsp | 81 + .../DurableTask.Management/scheduler.tsp | 197 ++ .../DurableTask.Management/taskhub.tsp | 51 + .../transparentDataEncryption.tsp | 64 + .../2026-05-01-preview/durabletask.json | 2326 +++++++++++++++++ .../examples/Operations_List.json | 36 + ...ointConnections_Create_MaximumSet_Gen.json | 84 + ...ointConnections_Delete_MaximumSet_Gen.json | 19 + ...ndpointConnections_Get_MaximumSet_Gen.json | 42 + ...dpointConnections_List_MaximumSet_Gen.json | 46 + .../PrivateEndpointConnections_Update.json | 54 + ...ivateLinkResources_Get_MaximumSet_Gen.json | 37 + ...vateLinkResources_List_MaximumSet_Gen.json | 41 + ...licies_CreateOrReplace_MaximumSet_Gen.json | 83 + ...tentionPolicies_Delete_MaximumSet_Gen.json | 19 + .../RetentionPolicies_Get_MaximumSet_Gen.json | 40 + ...licies_ListByScheduler_MaximumSet_Gen.json | 44 + ...tentionPolicies_Update_MaximumSet_Gen.json | 65 + .../examples/Schedulers_CreateOrUpdate.json | 106 + .../examples/Schedulers_Delete.json | 18 + .../examples/Schedulers_Get.json | 46 + .../Schedulers_ListByResourceGroup.json | 50 + .../Schedulers_ListBySubscription.json | 49 + .../examples/Schedulers_Restart.json | 13 + .../examples/Schedulers_Update.json | 70 + .../examples/TaskHubs_CreateOrUpdate.json | 64 + .../examples/TaskHubs_Delete.json | 19 + .../examples/TaskHubs_Get.json | 32 + .../examples/TaskHubs_ListByScheduler.json | 36 + ...ptions_CreateOrReplace_MaximumSet_Gen.json | 61 + ...DataEncryptions_Delete_MaximumSet_Gen.json | 18 + ...entDataEncryptions_Get_MaximumSet_Gen.json | 32 + ...ptions_ListByScheduler_MaximumSet_Gen.json | 37 + .../durabletask/resource-manager/readme.md | 50 +- 63 files changed, 5297 insertions(+), 284 deletions(-) create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Operations_List.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateEndpointConnections_Create_MaximumSet_Gen.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateEndpointConnections_Delete_MaximumSet_Gen.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateEndpointConnections_Get_MaximumSet_Gen.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateEndpointConnections_List_MaximumSet_Gen.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateEndpointConnections_Update.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateLinkResources_Get_MaximumSet_Gen.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateLinkResources_List_MaximumSet_Gen.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/RetentionPolicies_CreateOrReplace_MaximumSet_Gen.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/RetentionPolicies_Delete_MaximumSet_Gen.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/RetentionPolicies_Get_MaximumSet_Gen.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/RetentionPolicies_ListByScheduler_MaximumSet_Gen.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/RetentionPolicies_Update_MaximumSet_Gen.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_CreateOrUpdate.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_Delete.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_Get.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_ListByResourceGroup.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_ListBySubscription.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_Restart.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_Update.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TaskHubs_CreateOrUpdate.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TaskHubs_Delete.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TaskHubs_Get.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TaskHubs_ListByScheduler.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TransparentDataEncryptions_CreateOrReplace_MaximumSet_Gen.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TransparentDataEncryptions_Delete_MaximumSet_Gen.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TransparentDataEncryptions_Get_MaximumSet_Gen.json create mode 100644 specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TransparentDataEncryptions_ListByScheduler_MaximumSet_Gen.json create mode 100644 specification/durabletask/DurableTask.Management/retentionpolicy.tsp create mode 100644 specification/durabletask/DurableTask.Management/scheduler.tsp create mode 100644 specification/durabletask/DurableTask.Management/taskhub.tsp create mode 100644 specification/durabletask/DurableTask.Management/transparentDataEncryption.tsp create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/durabletask.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Operations_List.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateEndpointConnections_List_MaximumSet_Gen.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateEndpointConnections_Update.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateLinkResources_Get_MaximumSet_Gen.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateLinkResources_List_MaximumSet_Gen.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/RetentionPolicies_CreateOrReplace_MaximumSet_Gen.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/RetentionPolicies_Delete_MaximumSet_Gen.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/RetentionPolicies_Get_MaximumSet_Gen.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/RetentionPolicies_ListByScheduler_MaximumSet_Gen.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/RetentionPolicies_Update_MaximumSet_Gen.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_CreateOrUpdate.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_Delete.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_Get.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_ListByResourceGroup.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_ListBySubscription.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_Restart.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_Update.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TaskHubs_CreateOrUpdate.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TaskHubs_Delete.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TaskHubs_Get.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TaskHubs_ListByScheduler.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TransparentDataEncryptions_CreateOrReplace_MaximumSet_Gen.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TransparentDataEncryptions_Delete_MaximumSet_Gen.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TransparentDataEncryptions_Get_MaximumSet_Gen.json create mode 100644 specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TransparentDataEncryptions_ListByScheduler_MaximumSet_Gen.json diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Operations_List.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Operations_List.json new file mode 100644 index 000000000000..7897681644f8 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Operations_List.json @@ -0,0 +1,36 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2026-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "display": { + "description": "Create or Update Durable Task Scheduler", + "operation": "Create or Update Durable Task Scheduler", + "provider": "Durable Task Scheduler", + "resource": "Scheduler" + }, + "isDataAction": false, + "name": "Microsoft.DurableTask/schedulers/write" + }, + { + "display": { + "description": "Delete Durable Task Scheduler", + "operation": "Delete Durable Task Scheduler", + "provider": "Durable Task Scheduler", + "resource": "Scheduler" + }, + "isDataAction": false, + "name": "Microsoft.DurableTask/schedulers/delete" + } + ], + "nextLink": "https://microsoft.com/akpblld" + } + } + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateEndpointConnections_Create_MaximumSet_Gen.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateEndpointConnections_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..d211534a419e --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateEndpointConnections_Create_MaximumSet_Gen.json @@ -0,0 +1,84 @@ +{ + "title": "PrivateEndpointConnections_Create_MaximumSet", + "operationId": "Schedulers_CreateOrUpdatePrivateEndpointConnection", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "851A7597-D699-45CC-899B-7487A5B3B775", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler", + "privateEndpointConnectionName": "spzckqrbhfnabu", + "resource": { + "properties": { + "privateEndpoint": {}, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "mxymqfbbmpwjxsroldlsd", + "description": "ujdcsoyxljivwsgfkexhotaxcmzq" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "vjjxatyilmgjaervqztrmlpfodvbo" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "mxymqfbbmpwjxsroldlsd", + "description": "ujdcsoyxljivwsgfkexhotaxcmzq" + }, + "groupIds": [ + "xnnrzmowptxnijdojrntrbm" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/851A7597-D699-45CC-899B-7487A5B3B775/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/privateEndpointConnections/spzckqrbhfnabu", + "name": "spzckqrbhfnabu", + "type": "Microsoft.DurableTask/schedulers/privateEndpointConnections", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "privateEndpoint": { + "id": "vjjxatyilmgjaervqztrmlpfodvbo" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "mxymqfbbmpwjxsroldlsd", + "description": "ujdcsoyxljivwsgfkexhotaxcmzq" + }, + "groupIds": [ + "xnnrzmowptxnijdojrntrbm" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/851A7597-D699-45CC-899B-7487A5B3B775/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/privateEndpointConnections/spzckqrbhfnabu", + "name": "spzckqrbhfnabu", + "type": "Microsoft.DurableTask/schedulers/privateEndpointConnections", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + } + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateEndpointConnections_Delete_MaximumSet_Gen.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateEndpointConnections_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..13e7d8234329 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateEndpointConnections_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "PrivateEndpointConnections_Delete_MaximumSet", + "operationId": "Schedulers_DeletePrivateEndpointConnection", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "851A7597-D699-45CC-899B-7487A5B3B775", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler", + "privateEndpointConnectionName": "spzckqrbhfnabu" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateEndpointConnections_Get_MaximumSet_Gen.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateEndpointConnections_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b65023a271f7 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateEndpointConnections_Get_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "PrivateEndpointConnections_Get_MaximumSet", + "operationId": "Schedulers_GetPrivateEndpointConnection", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "851A7597-D699-45CC-899B-7487A5B3B775", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler", + "privateEndpointConnectionName": "spzckqrbhfnabu" + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "vjjxatyilmgjaervqztrmlpfodvbo" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "mxymqfbbmpwjxsroldlsd", + "description": "ujdcsoyxljivwsgfkexhotaxcmzq" + }, + "groupIds": [ + "xnnrzmowptxnijdojrntrbm" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/851A7597-D699-45CC-899B-7487A5B3B775/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/privateEndpointConnections/spzckqrbhfnabu", + "name": "spzckqrbhfnabu", + "type": "Microsoft.DurableTask/schedulers/privateEndpointConnections", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + } + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateEndpointConnections_List_MaximumSet_Gen.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateEndpointConnections_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..298786fe4980 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateEndpointConnections_List_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "PrivateEndpointConnections_List_MaximumSet", + "operationId": "Schedulers_ListPrivateEndpointConnections", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "851A7597-D699-45CC-899B-7487A5B3B775", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "privateEndpoint": { + "id": "vjjxatyilmgjaervqztrmlpfodvbo" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "mxymqfbbmpwjxsroldlsd", + "description": "ujdcsoyxljivwsgfkexhotaxcmzq" + }, + "groupIds": [ + "xnnrzmowptxnijdojrntrbm" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/851A7597-D699-45CC-899B-7487A5B3B775/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/privateEndpointConnections/spzckqrbhfnabu", + "name": "spzckqrbhfnabu", + "type": "Microsoft.DurableTask/schedulers/privateEndpointConnections", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + ], + "nextLink": "https://microsoft.com/anend" + } + } + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateEndpointConnections_Update.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateEndpointConnections_Update.json new file mode 100644 index 000000000000..471882439121 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateEndpointConnections_Update.json @@ -0,0 +1,54 @@ +{ + "title": "PrivateEndpointConnections_Update", + "operationId": "Schedulers_UpdatePrivateEndpointConnection", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "851A7597-D699-45CC-899B-7487A5B3B775", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler", + "privateEndpointConnectionName": "spzckqrbhfnabu", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "vjjxatyilmgjaervqztrmlpfodvbo" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "mxymqfbbmpwjxsroldlsd", + "description": "ujdcsoyxljivwsgfkexhotaxcmzq" + }, + "groupIds": [ + "xnnrzmowptxnijdojrntrbm" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/851A7597-D699-45CC-899B-7487A5B3B775/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/privateEndpointConnections/spzckqrbhfnabu", + "name": "spzckqrbhfnabu", + "type": "Microsoft.DurableTask/schedulers/privateEndpointConnections", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateLinkResources_Get_MaximumSet_Gen.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateLinkResources_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..62cc6b54b7fb --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateLinkResources_Get_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "PrivateLinkResources_Get_MaximumSet", + "operationId": "Schedulers_GetPrivateLink", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "851A7597-D699-45CC-899B-7487A5B3B775", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler", + "privateLinkResourceName": "ulbdiqhrmwnkejje" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "mexetpneryldlrtmuxzxhwezfjkcvr", + "requiredMembers": [ + "ftzshharzmwhcemnbdwlmyhtxkpa" + ], + "requiredZoneNames": [ + "lkwwgycaduib" + ] + }, + "id": "/subscriptions/851A7597-D699-45CC-899B-7487A5B3B775/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/privateLinkResources/ulbdiqhrmwnkejje", + "name": "ulbdiqhrmwnkejje", + "type": "Microsoft.DurableTask/schedulers/privateLinkResources", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + } + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateLinkResources_List_MaximumSet_Gen.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateLinkResources_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..4c41f51eb468 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/PrivateLinkResources_List_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "PrivateLinkResources_List_MaximumSet", + "operationId": "Schedulers_ListPrivateLinks", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "851A7597-D699-45CC-899B-7487A5B3B775", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "mexetpneryldlrtmuxzxhwezfjkcvr", + "requiredMembers": [ + "ftzshharzmwhcemnbdwlmyhtxkpa" + ], + "requiredZoneNames": [ + "lkwwgycaduib" + ] + }, + "id": "/subscriptions/851A7597-D699-45CC-899B-7487A5B3B775/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/privateLinkResources/ulbdiqhrmwnkejje", + "name": "ulbdiqhrmwnkejje", + "type": "Microsoft.DurableTask/schedulers/privateLinkResources", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/RetentionPolicies_CreateOrReplace_MaximumSet_Gen.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/RetentionPolicies_CreateOrReplace_MaximumSet_Gen.json new file mode 100644 index 000000000000..77079cdc0775 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/RetentionPolicies_CreateOrReplace_MaximumSet_Gen.json @@ -0,0 +1,83 @@ +{ + "title": "RetentionPolicies_CreateOrReplace_MaximumSet", + "operationId": "RetentionPolicies_CreateOrReplace", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "194D3C1E-462F-4738-9025-092A628C06EB", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler", + "retentionPolicyName": "default", + "resource": { + "properties": { + "retentionPolicies": [ + { + "retentionPeriodInDays": 30 + }, + { + "retentionPeriodInDays": 10, + "orchestrationState": "Failed" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "retentionPolicies": [ + { + "retentionPeriodInDays": 30 + }, + { + "retentionPeriodInDays": 10, + "orchestrationState": "Failed" + } + ] + }, + "id": "/subscriptions/194D3C1E-462F-4738-9025-092A628C06EB/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/retentionPolicies/default", + "name": "default", + "type": "Microsoft.DurableTask/schedulers/retentionPolicies", + "systemData": { + "createdBy": "zshkmc", + "createdByType": "User", + "createdAt": "2025-03-31T23:34:09.612Z", + "lastModifiedBy": "ivqrae", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-03-31T23:34:09.612Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "retentionPolicies": [ + { + "retentionPeriodInDays": 30 + }, + { + "retentionPeriodInDays": 10, + "orchestrationState": "Failed" + } + ] + }, + "id": "/subscriptions/194D3C1E-462F-4738-9025-092A628C06EB/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/retentionPolicies/default", + "name": "default", + "type": "Microsoft.DurableTask/schedulers/retentionPolicies", + "systemData": { + "createdBy": "zshkmc", + "createdByType": "User", + "createdAt": "2025-03-31T23:34:09.612Z", + "lastModifiedBy": "ivqrae", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-03-31T23:34:09.612Z" + } + } + } + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/RetentionPolicies_Delete_MaximumSet_Gen.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/RetentionPolicies_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..cd5d22441601 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/RetentionPolicies_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "RetentionPolicies_Delete_MaximumSet", + "operationId": "RetentionPolicies_Delete", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "194D3C1E-462F-4738-9025-092A628C06EB", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testcheduler", + "retentionPolicyName": "default" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/RetentionPolicies_Get_MaximumSet_Gen.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/RetentionPolicies_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..9fd66c899cd6 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/RetentionPolicies_Get_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "RetentionPolicies_Get_MaximumSet", + "operationId": "RetentionPolicies_Get", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "194D3C1E-462F-4738-9025-092A628C06EB", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler", + "retentionPolicyName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "retentionPolicies": [ + { + "retentionPeriodInDays": 30 + }, + { + "retentionPeriodInDays": 10, + "orchestrationState": "Failed" + } + ] + }, + "id": "/subscriptions/194D3C1E-462F-4738-9025-092A628C06EB/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/retentionPolicies/default", + "name": "default", + "type": "Microsoft.DurableTask/schedulers/retentionPolicies", + "systemData": { + "createdBy": "zshkmc", + "createdByType": "User", + "createdAt": "2025-03-31T23:34:09.612Z", + "lastModifiedBy": "ivqrae", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-03-31T23:34:09.612Z" + } + } + } + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/RetentionPolicies_ListByScheduler_MaximumSet_Gen.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/RetentionPolicies_ListByScheduler_MaximumSet_Gen.json new file mode 100644 index 000000000000..547dc718b4d7 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/RetentionPolicies_ListByScheduler_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "RetentionPolicies_ListByScheduler_MaximumSet", + "operationId": "RetentionPolicies_ListByScheduler", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "194D3C1E-462F-4738-9025-092A628C06EB", + "resourceGroupName": "rgdurabletask", + "schedulerName": "myscheduler" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "retentionPolicies": [ + { + "retentionPeriodInDays": 30 + }, + { + "retentionPeriodInDays": 10, + "orchestrationState": "Failed" + } + ] + }, + "id": "/subscriptions/194D3C1E-462F-4738-9025-092A628C06EB/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/retentionPolicies/default", + "name": "default", + "type": "Microsoft.DurableTask/schedulers/retentionPolicies", + "systemData": { + "createdBy": "zshkmc", + "createdByType": "User", + "createdAt": "2025-03-31T23:34:09.612Z", + "lastModifiedBy": "ivqrae", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-03-31T23:34:09.612Z" + } + } + ], + "nextLink": "https://microsoft.com/ai" + } + } + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/RetentionPolicies_Update_MaximumSet_Gen.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/RetentionPolicies_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..3784113156ed --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/RetentionPolicies_Update_MaximumSet_Gen.json @@ -0,0 +1,65 @@ +{ + "title": "RetentionPolicies_Update_MaximumSet", + "operationId": "RetentionPolicies_Update", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "194D3C1E-462F-4738-9025-092A628C06EB", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler", + "retentionPolicyName": "default", + "properties": { + "properties": { + "retentionPolicies": [ + { + "retentionPeriodInDays": 30 + }, + { + "retentionPeriodInDays": 10, + "orchestrationState": "Failed" + }, + { + "retentionPeriodInDays": 24, + "orchestrationState": "Completed" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "retentionPolicies": [ + { + "retentionPeriodInDays": 30 + }, + { + "retentionPeriodInDays": 10, + "orchestrationState": "Failed" + }, + { + "retentionPeriodInDays": 24, + "orchestrationState": "Completed" + } + ] + }, + "id": "/subscriptions/194D3C1E-462F-4738-9025-092A628C06EB/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/retentionPolicies/default", + "name": "default", + "type": "Microsoft.DurableTask/schedulers/retentionPolicies", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_CreateOrUpdate.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_CreateOrUpdate.json new file mode 100644 index 000000000000..633f9f3b79fc --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_CreateOrUpdate.json @@ -0,0 +1,106 @@ +{ + "title": "Schedulers_CreateOrUpdate", + "operationId": "Schedulers_CreateOrUpdate", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgopenapi", + "schedulerName": "testscheduler", + "resource": { + "location": "northcentralus", + "properties": { + "ipAllowlist": [ + "10.0.0.0/8" + ], + "sku": { + "name": "Dedicated" + } + }, + "tags": { + "department": "research", + "development": "true" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "northcentralus", + "properties": { + "provisioningState": "Succeeded", + "endpoint": "https://test.northcentralus.1.durabletask.io", + "ipAllowlist": [ + "10.0.0.0/8" + ], + "sku": { + "name": "Dedicated", + "capacity": 3, + "redundancyState": "Zone" + } + }, + "tags": { + "department": "research", + "development": "true" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": {} + } + }, + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler", + "name": "testscheduler", + "type": "Microsoft.DurableTask/schedulers", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "location": "northcentralus", + "properties": { + "provisioningState": "Succeeded", + "endpoint": "https://test.northcentralus.1.durabletask.io", + "ipAllowlist": [ + "10.0.0.0/8" + ], + "sku": { + "name": "Dedicated", + "capacity": 3, + "redundancyState": "Zone" + } + }, + "tags": { + "department": "research", + "development": "true" + }, + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler", + "name": "testscheduler", + "type": "Microsoft.DurableTask/schedulers", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + } + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_Delete.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_Delete.json new file mode 100644 index 000000000000..23d0d162c99f --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Schedulers_Delete", + "operationId": "Schedulers_Delete", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgopenapi", + "schedulerName": "testscheduler" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_Get.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_Get.json new file mode 100644 index 000000000000..fc307bad65f4 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_Get.json @@ -0,0 +1,46 @@ +{ + "title": "Schedulers_Get", + "operationId": "Schedulers_Get", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgopenapi", + "schedulerName": "testscheduler" + }, + "responses": { + "200": { + "body": { + "location": "northcentralus", + "properties": { + "provisioningState": "Succeeded", + "endpoint": "https://test.northcentralus.1.durabletask.io", + "ipAllowlist": [ + "10.0.0.0/8" + ], + "sku": { + "name": "Dedicated", + "capacity": 3, + "redundancyState": "Zone" + }, + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [] + }, + "tags": { + "department": "research", + "development": "true" + }, + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler", + "name": "testscheduler", + "type": "Microsoft.DurableTask/schedulers", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + } + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_ListByResourceGroup.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_ListByResourceGroup.json new file mode 100644 index 000000000000..6636c137f5c1 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_ListByResourceGroup.json @@ -0,0 +1,50 @@ +{ + "title": "Schedulers_ListByResourceGroup", + "operationId": "Schedulers_ListByResourceGroup", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgopenapi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler", + "location": "northcentralus", + "properties": { + "provisioningState": "Succeeded", + "endpoint": "https://test.northcentralus.1.durabletask.io", + "ipAllowlist": [ + "10.0.0.0/8" + ], + "sku": { + "name": "Dedicated", + "capacity": 3, + "redundancyState": "Zone" + }, + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [] + }, + "tags": { + "department": "research", + "development": "true" + }, + "name": "testscheduler", + "type": "Microsoft.DurableTask/schedulers", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_ListBySubscription.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_ListBySubscription.json new file mode 100644 index 000000000000..74d67623d0d9 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_ListBySubscription.json @@ -0,0 +1,49 @@ +{ + "title": "Schedulers_ListBySubscription", + "operationId": "Schedulers_ListBySubscription", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler", + "location": "northcentralus", + "properties": { + "provisioningState": "Succeeded", + "endpoint": "https://test.northcentralus.1.durabletask.io", + "ipAllowlist": [ + "10.0.0.0/8" + ], + "sku": { + "name": "Dedicated", + "capacity": 3, + "redundancyState": "Zone" + }, + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [] + }, + "tags": { + "department": "research", + "development": "true" + }, + "name": "testscheduler", + "type": "Microsoft.DurableTask/schedulers", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_Restart.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_Restart.json new file mode 100644 index 000000000000..935d4236d3b4 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_Restart.json @@ -0,0 +1,13 @@ +{ + "title": "Schedulers_Restart", + "operationId": "Schedulers_Restart", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgopenapi", + "schedulerName": "testscheduler" + }, + "responses": { + "204": {} + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_Update.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_Update.json new file mode 100644 index 000000000000..84fa53a9f62b --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/Schedulers_Update.json @@ -0,0 +1,70 @@ +{ + "title": "Schedulers_Update", + "operationId": "Schedulers_Update", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgopenapi", + "schedulerName": "testscheduler", + "properties": { + "tags": { + "hello": "world" + }, + "properties": { + "ipAllowlist": [ + "10.0.0.0/8" + ], + "sku": { + "name": "Dedicated", + "capacity": 3 + } + }, + "identity": { + "type": "None" + } + } + }, + "responses": { + "200": { + "body": { + "location": "northcentralus", + "properties": { + "provisioningState": "Succeeded", + "endpoint": "https://test.northcentralus.1.durabletask.io", + "ipAllowlist": [ + "10.0.0.0/8" + ], + "sku": { + "name": "Dedicated", + "capacity": 3, + "redundancyState": "Zone" + } + }, + "tags": { + "department": "research", + "development": "true", + "hello": "world" + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler", + "name": "testscheduler", + "type": "Microsoft.DurableTask/schedulers", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TaskHubs_CreateOrUpdate.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TaskHubs_CreateOrUpdate.json new file mode 100644 index 000000000000..9380833825c5 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TaskHubs_CreateOrUpdate.json @@ -0,0 +1,64 @@ +{ + "title": "TaskHubs_CreateOrUpdate", + "operationId": "TaskHubs_CreateOrUpdate", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgopenapi", + "schedulerName": "testscheduler", + "taskHubName": "testtaskhub", + "resource": { + "properties": { + "capabilities": [ + "ExampleFutureCapability" + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "dashboardUrl": "https://test-db.northcentralus.1.durabletask.io/taskhubs/testtaskhub", + "capabilities": [ + "ExampleFutureCapability" + ] + }, + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler/taskHubs/testtaskhub", + "name": "testtaskhub", + "type": "Microsoft.DurableTask/schedulers/taskHubs", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "dashboardUrl": "https://test-db.northcentralus.1.durabletask.io/taskhubs/testtaskhub", + "capabilities": [ + "ExampleFutureCapability" + ] + }, + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler/taskHubs/testtaskhub", + "name": "testtaskhub", + "type": "Microsoft.DurableTask/schedulers/taskHubs", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + } + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TaskHubs_Delete.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TaskHubs_Delete.json new file mode 100644 index 000000000000..0aac04818901 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TaskHubs_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "TaskHubs_Delete", + "operationId": "TaskHubs_Delete", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgopenapi", + "schedulerName": "testscheduler", + "taskHubName": "testtaskhub" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TaskHubs_Get.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TaskHubs_Get.json new file mode 100644 index 000000000000..90a41f2a1c31 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TaskHubs_Get.json @@ -0,0 +1,32 @@ +{ + "title": "TaskHubs_Get", + "operationId": "TaskHubs_Get", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgopenapi", + "schedulerName": "testscheduler", + "taskHubName": "testtaskhub" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "dashboardUrl": "https://test-db.northcentralus.1.durabletask.io/taskhubs/testtaskhub" + }, + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler/taskHubs/testtaskhub", + "name": "testtaskhub", + "type": "Microsoft.DurableTask/schedulers/taskHubs", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + } + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TaskHubs_ListByScheduler.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TaskHubs_ListByScheduler.json new file mode 100644 index 000000000000..51e1fd101282 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TaskHubs_ListByScheduler.json @@ -0,0 +1,36 @@ +{ + "title": "TaskHubs_ListByScheduler", + "operationId": "TaskHubs_ListByScheduler", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgopenapi", + "schedulerName": "testscheduler" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler/taskHubs/testtaskhub", + "properties": { + "provisioningState": "Succeeded", + "dashboardUrl": "https://test-db.northcentralus.1.durabletask.io/taskhubs/testtaskhub" + }, + "name": "testtaskhub", + "type": "Microsoft.DurableTask/schedulers/taskHubs", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TransparentDataEncryptions_CreateOrReplace_MaximumSet_Gen.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TransparentDataEncryptions_CreateOrReplace_MaximumSet_Gen.json new file mode 100644 index 000000000000..bbc2fbf5c1f8 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TransparentDataEncryptions_CreateOrReplace_MaximumSet_Gen.json @@ -0,0 +1,61 @@ +{ + "title": "TransparentDataEncryptions_CreateOrReplace_MaximumSet", + "operationId": "TransparentDataEncryptions_CreateOrReplace", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler", + "resource": { + "properties": { + "keySource": "CustomerManaged", + "keyVaultKeyUri": "https://microsoft.com/ap" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "keySource": "CustomerManaged", + "keyVaultKeyUri": "https://microsoft.com/ap" + }, + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/transparentDataEncryptions/default", + "name": "default", + "type": "Microsoft.DurableTask/schedulers/transparentDataEncryptions", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "keySource": "CustomerManaged", + "keyVaultKeyUri": "https://microsoft.com/ap" + }, + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/transparentDataEncryptions/default", + "name": "default", + "type": "Microsoft.DurableTask/schedulers/transparentDataEncryptions", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + } + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TransparentDataEncryptions_Delete_MaximumSet_Gen.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TransparentDataEncryptions_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..7fb383504e46 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TransparentDataEncryptions_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "TransparentDataEncryptions_Delete_MaximumSet", + "operationId": "TransparentDataEncryptions_Delete", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TransparentDataEncryptions_Get_MaximumSet_Gen.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TransparentDataEncryptions_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..4dd395e082a6 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TransparentDataEncryptions_Get_MaximumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "title": "TransparentDataEncryptions_Get_MaximumSet", + "operationId": "TransparentDataEncryptions_Get", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "keySource": "CustomerManaged", + "keyVaultKeyUri": "https://microsoft.com/ap" + }, + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/transparentDataEncryptions/default", + "name": "default", + "type": "Microsoft.DurableTask/schedulers/transparentDataEncryptions", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + } + } +} diff --git a/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TransparentDataEncryptions_ListByScheduler_MaximumSet_Gen.json b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TransparentDataEncryptions_ListByScheduler_MaximumSet_Gen.json new file mode 100644 index 000000000000..586315516953 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/examples/2026-05-01-preview/TransparentDataEncryptions_ListByScheduler_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "TransparentDataEncryptions_ListByScheduler_MaximumSet", + "operationId": "TransparentDataEncryptions_ListByScheduler", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "keySource": "CustomerManaged", + "keyVaultKeyUri": "https://microsoft.com/ap" + }, + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/transparentDataEncryptions/default", + "name": "default", + "type": "Microsoft.DurableTask/schedulers/transparentDataEncryptions", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/durabletask/DurableTask.Management/main.tsp b/specification/durabletask/DurableTask.Management/main.tsp index 7a4e5f851113..a1626f584b9c 100644 --- a/specification/durabletask/DurableTask.Management/main.tsp +++ b/specification/durabletask/DurableTask.Management/main.tsp @@ -2,6 +2,10 @@ import "@typespec/http"; import "@typespec/rest"; import "@typespec/versioning"; import "@azure-tools/typespec-azure-resource-manager"; +import "./scheduler.tsp"; +import "./taskhub.tsp"; +import "./retentionpolicy.tsp"; +import "./transparentDataEncryption.tsp"; using TypeSpec.Rest; using TypeSpec.Versioning; @@ -14,12 +18,6 @@ namespace Microsoft.DurableTask; interface Operations extends Azure.ResourceManager.Operations {} -model SchedulerPrivateLinkResource is PrivateLink; -alias PrivateLinkOperations = PrivateLinks; - -model PrivateEndpointConnection is PrivateEndpointConnectionResource; -alias PrivateEndpointOperations = PrivateEndpoints; - @doc("API Versions") enum Versions { @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) @@ -37,171 +35,10 @@ enum Versions { @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v6) @doc("2026-02-01") v2026_02_01: "2026-02-01", -} - -@doc("A Durable Task Scheduler resource") -@added(Versions.v2024_10_01_Preview) -model Scheduler is Azure.ResourceManager.TrackedResource { - ...ResourceNameParameter< - Scheduler, - "schedulerName", - "schedulers", - "^[a-zA-Z0-9-]{3,64}$" - >; -} - -@doc("Details of the Scheduler") -@added(Versions.v2024_10_01_Preview) -model SchedulerProperties { - @visibility(Lifecycle.Read) - @doc("The status of the last operation") - provisioningState?: ProvisioningState; - - @doc("URL of the durable task scheduler") - @visibility(Lifecycle.Read) - endpoint?: string; - - @doc("IP allow list for durable task scheduler. Values can be IPv4, IPv6 or CIDR") - ipAllowlist: string[]; - - @doc("SKU of the durable task scheduler") - sku: SchedulerSku; - - @added(Versions.v2026_02_01) - @doc("Allow or disallow public network access to durable task scheduler") - publicNetworkAccess?: PublicNetworkAccess; - - /** The private endpoints exposed by this resource */ - @added(Versions.v2026_02_01) - @visibility(Lifecycle.Read) - privateEndpointConnections?: PrivateEndpointConnection[]; -} - -@doc("The SKU (Stock Keeping Unit) assigned to this durable task scheduler") -@added(Versions.v2024_10_01_Preview) -model SchedulerSku { - @doc("The name of the SKU") - @typeChangedFrom(Versions.v2025_11_01, string) - name: SchedulerSkuName; - - @doc("The SKU capacity. This allows scale out/in for the resource and impacts zone redundancy") - capacity?: int32; - - @doc("Indicates whether the current SKU configuration is zone redundant") - @visibility(Lifecycle.Read) - redundancyState?: RedundancyState; -} - -@added(Versions.v2025_11_01) -@doc("The name of the Stock Keeping Unit (SKU) of a Durable Task Scheduler") -union SchedulerSkuName { - string, - @doc("Dedicated SKU") - Dedicated: "Dedicated", - - @doc("Consumption SKU") - @added(Versions.v2025_04_01_Preview) - Consumption: "Consumption", -} - -@doc("A Task Hub resource belonging to the scheduler") -@added(Versions.v2024_10_01_Preview) -@parentResource(Scheduler) -model TaskHub is Azure.ResourceManager.ProxyResource { - ...ResourceNameParameter< - TaskHub, - "taskHubName", - "taskHubs", - "^[a-zA-Z0-9-]{3,64}$" - >; -} - -@doc("The state of the resource redundancy") -union RedundancyState { - string, - - @doc("The resource is not redundant") - None: "None", - - @doc("The resource is zone redundant") - Zone: "Zone", -} - -@doc("The properties of Task Hub") -model TaskHubProperties { - @visibility(Lifecycle.Read) - @doc("The status of the last operation") - provisioningState?: ProvisioningState; - - @doc("URL of the durable task scheduler dashboard") - @visibility(Lifecycle.Read) - dashboardUrl?: url; -} - -@doc("A retention policy resource belonging to the scheduler") -@added(Versions.v2025_04_01_Preview) -@parentResource(Scheduler) -@singleton -model RetentionPolicy - is Azure.ResourceManager.ProxyResource { - ...ResourceNameParameter< - RetentionPolicy, - "retentionPolicyName", - "retentionPolicies" - >; -} - -@doc("The retention policy settings for the resource") -@added(Versions.v2025_04_01_Preview) -model RetentionPolicyProperties { - @visibility(Lifecycle.Read) - @doc("The status of the last operation") - provisioningState?: ProvisioningState; - - @doc("The orchestration retention policies") - @identifiers(#["retentionPeriodInDays", "orchestrationState"]) - retentionPolicies?: RetentionPolicyDetails[]; -} - -@doc("The properties of a retention policy") -@added(Versions.v2025_04_01_Preview) -model RetentionPolicyDetails { - @doc("The retention period in days after which the orchestration will be purged automatically") - retentionPeriodInDays: int32; - - @doc("The orchestration state to which this policy applies. If omitted, the policy applies to all purgeable orchestration states.") - orchestrationState?: PurgeableOrchestrationState; -} - -@doc("State of the public network access.") -@added(Versions.v2026_02_01) -union PublicNetworkAccess { - string, - - @doc("The public network access is enabled") - Enabled: "Enabled", - - @doc("The public network access is disabled") - Disabled: "Disabled", -} - -@doc("Purgeable orchestration state to be used in retention policies") -@added(Versions.v2025_04_01_Preview) -union PurgeableOrchestrationState { - string, - - @doc("The orchestration is completed") - Completed: "Completed", - - @doc("The orchestration is failed") - Failed: "Failed", - - @doc("The orchestration is terminated") - Terminated: "Terminated", - - @doc("The orchestration is canceled") - Canceled: "Canceled", + @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v6) + @doc("2026-05-01-preview") + v2026_05_01_Preview: "2026-05-01-preview", } @doc("The status of the current operation") @@ -222,116 +59,3 @@ union ProvisioningState { @doc("The resource create request has been accepted") Accepted: "Accepted", } - -@doc("The update request model for the Scheduler resource") -model SchedulerUpdate - is UpdateableProperties>; - -@doc("The Scheduler resource properties to be updated") -model SchedulerPropertiesUpdate { - @visibility(Lifecycle.Read) - @doc("The status of the last operation") - provisioningState?: ProvisioningState; - - @doc("URL of the durable task scheduler") - @visibility(Lifecycle.Read) - endpoint?: string; - - @doc("IP allow list for durable task scheduler. Values can be IPv4, IPv6 or CIDR") - ipAllowlist?: string[]; - - @doc("SKU of the durable task scheduler") - sku?: SchedulerSkuUpdate; - - @added(Versions.v2026_02_01) - @doc("Allow or disallow public network access to durable task scheduler") - publicNetworkAccess?: PublicNetworkAccess; -} - -@doc("The SKU (Stock Keeping Unit) properties to be updated") -model SchedulerSkuUpdate { - @doc("The name of the SKU") - @typeChangedFrom(Versions.v2025_11_01, string) - name?: SchedulerSkuName; - - @doc("The SKU capacity. This allows scale out/in for the resource and impacts zone redundancy") - capacity?: int32; - - @doc("Indicates whether the current SKU configuration is zone redundant") - @visibility(Lifecycle.Read) - redundancyState?: RedundancyState; -} - -@armResourceOperations(Scheduler) -interface Schedulers { - @doc("Get a Scheduler") - @errorsDoc("Not found error: resource does not exist") - get is ArmResourceRead; - @doc("Create or update a Scheduler") - @errorsDoc("Validation error: required parameters are missing") - createOrUpdate is ArmResourceCreateOrReplaceAsync; - @doc("Update a Scheduler") - @errorsDoc("Validation error: required parameters are missing") - update is ArmCustomPatchAsync; - @doc("Delete a Scheduler") - delete is ArmResourceDeleteWithoutOkAsync; - @doc("List Schedulers by resource group") - listByResourceGroup is ArmResourceListByParent; - @doc("List Schedulers by subscription") - listBySubscription is ArmListBySubscription; - - @added(Versions.v2026_02_01) - @doc("Get a private link resource for the durable task scheduler") - getPrivateLink is PrivateLinkOperations.Read; - @added(Versions.v2026_02_01) - @doc("List private link resources for the durable task scheduler") - listPrivateLinks is PrivateLinkOperations.ListByParent; - - @added(Versions.v2026_02_01) - @doc("Get a private endpoint connection for the durable task scheduler") - getPrivateEndpointConnection is PrivateEndpointOperations.Read; - @added(Versions.v2026_02_01) - @doc("Create or update a private endpoint connection for the durable task scheduler") - createOrUpdatePrivateEndpointConnection is PrivateEndpointOperations.CreateOrUpdateAsync; - @added(Versions.v2026_02_01) - @doc("Update a private endpoint connection for the durable task scheduler") - updatePrivateEndpointConnection is PrivateEndpointOperations.CustomPatchAsync; - @added(Versions.v2026_02_01) - @doc("Delete a private endpoint connection for the durable task scheduler") - deletePrivateEndpointConnection is PrivateEndpointOperations.DeleteAsync; - @added(Versions.v2026_02_01) - @doc("List private endpoint connections for the durable task scheduler") - listPrivateEndpointConnections is PrivateEndpointOperations.ListByParent; -} - -@armResourceOperations(TaskHub) -interface TaskHubs { - @doc("Get a Task Hub") - @errorsDoc("Not found error: resource does not exist") - get is ArmResourceRead; - @doc("Create or Update a Task Hub") - @errorsDoc("Validation error: required parameters are missing") - createOrUpdate is ArmResourceCreateOrReplaceAsync; - @doc("Delete a Task Hub") - delete is ArmResourceDeleteWithoutOkAsync; - @doc("List Task Hubs") - listByScheduler is ArmResourceListByParent; -} - -@added(Versions.v2025_04_01_Preview) -@armResourceOperations(RetentionPolicy) -interface RetentionPolicies { - @doc("Get a Retention Policy") - @errorsDoc("Not found error: resource does not exist") - get is ArmResourceRead; - @doc("Create or Update a Retention Policy") - @errorsDoc("Validation error: required parameters are missing") - createOrReplace is ArmResourceCreateOrReplaceAsync; - @doc("Update a Retention Policy") - @errorsDoc("Validation error: required parameters are missing") - update is ArmResourcePatchAsync; - @doc("Delete a Retention Policy") - delete is ArmResourceDeleteWithoutOkAsync; - @doc("List Retention Policies") - listByScheduler is ArmResourceListByParent; -} diff --git a/specification/durabletask/DurableTask.Management/retentionpolicy.tsp b/specification/durabletask/DurableTask.Management/retentionpolicy.tsp new file mode 100644 index 000000000000..b44eef695b78 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/retentionpolicy.tsp @@ -0,0 +1,81 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.ResourceManager; + +namespace Microsoft.DurableTask; + +@doc("A retention policy resource belonging to the scheduler") +@added(Versions.v2025_04_01_Preview) +@parentResource(Scheduler) +@singleton +model RetentionPolicy + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + RetentionPolicy, + "retentionPolicyName", + "retentionPolicies" + >; +} + +@doc("The retention policy settings for the resource") +@added(Versions.v2025_04_01_Preview) +model RetentionPolicyProperties { + @visibility(Lifecycle.Read) + @doc("The status of the last operation") + provisioningState?: ProvisioningState; + + @doc("The orchestration retention policies") + @identifiers(#["retentionPeriodInDays", "orchestrationState"]) + retentionPolicies?: RetentionPolicyDetails[]; +} + +@doc("The properties of a retention policy") +@added(Versions.v2025_04_01_Preview) +model RetentionPolicyDetails { + @doc("The retention period in days after which the orchestration will be purged automatically") + retentionPeriodInDays: int32; + + @doc("The orchestration state to which this policy applies. If omitted, the policy applies to all purgeable orchestration states.") + orchestrationState?: PurgeableOrchestrationState; +} + +@doc("Purgeable orchestration state to be used in retention policies") +@added(Versions.v2025_04_01_Preview) +union PurgeableOrchestrationState { + string, + + @doc("The orchestration is completed") + Completed: "Completed", + + @doc("The orchestration is failed") + Failed: "Failed", + + @doc("The orchestration is terminated") + Terminated: "Terminated", + + @doc("The orchestration is canceled") + Canceled: "Canceled", +} + +@added(Versions.v2025_04_01_Preview) +@armResourceOperations(RetentionPolicy) +interface RetentionPolicies { + @doc("Get a Retention Policy") + @errorsDoc("Not found error: resource does not exist") + get is ArmResourceRead; + @doc("Create or Update a Retention Policy") + @errorsDoc("Validation error: required parameters are missing") + createOrReplace is ArmResourceCreateOrReplaceAsync; + @doc("Update a Retention Policy") + @errorsDoc("Validation error: required parameters are missing") + update is ArmResourcePatchAsync; + @doc("Delete a Retention Policy") + delete is ArmResourceDeleteWithoutOkAsync; + @doc("List Retention Policies") + listByScheduler is ArmResourceListByParent; +} diff --git a/specification/durabletask/DurableTask.Management/scheduler.tsp b/specification/durabletask/DurableTask.Management/scheduler.tsp new file mode 100644 index 000000000000..9970862ef048 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/scheduler.tsp @@ -0,0 +1,197 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.ResourceManager; + +namespace Microsoft.DurableTask; + +model SchedulerPrivateLinkResource is PrivateLink; +alias PrivateLinkOperations = PrivateLinks; + +model PrivateEndpointConnection is PrivateEndpointConnectionResource; +alias PrivateEndpointOperations = PrivateEndpoints; + +@doc("A Durable Task Scheduler resource") +@added(Versions.v2024_10_01_Preview) +model Scheduler is Azure.ResourceManager.TrackedResource { + ...ResourceNameParameter< + Scheduler, + "schedulerName", + "schedulers", + "^[a-zA-Z0-9-]{3,64}$" + >; + ...ManagedServiceIdentityProperty; +} + +@@added(Scheduler.identity, Versions.v2026_05_01_Preview); + +@doc("Details of the Scheduler") +@added(Versions.v2024_10_01_Preview) +model SchedulerProperties { + @visibility(Lifecycle.Read) + @doc("The status of the last operation") + provisioningState?: ProvisioningState; + + @doc("URL of the durable task scheduler") + @visibility(Lifecycle.Read) + endpoint?: string; + + @doc("IP allow list for durable task scheduler. Values can be IPv4, IPv6 or CIDR") + ipAllowlist: string[]; + + @doc("SKU of the durable task scheduler") + sku: SchedulerSku; + + @added(Versions.v2026_02_01) + @doc("Allow or disallow public network access to durable task scheduler") + publicNetworkAccess?: PublicNetworkAccess; + + /** The private endpoints exposed by this resource */ + @added(Versions.v2026_02_01) + @visibility(Lifecycle.Read) + privateEndpointConnections?: PrivateEndpointConnection[]; +} + +@doc("The SKU (Stock Keeping Unit) assigned to this durable task scheduler") +@added(Versions.v2024_10_01_Preview) +model SchedulerSku { + @doc("The name of the SKU") + @typeChangedFrom(Versions.v2025_11_01, string) + name: SchedulerSkuName; + + @doc("The SKU capacity. This allows scale out/in for the resource and impacts zone redundancy") + capacity?: int32; + + @doc("Indicates whether the current SKU configuration is zone redundant") + @visibility(Lifecycle.Read) + redundancyState?: RedundancyState; +} + +@added(Versions.v2025_11_01) +@doc("The name of the Stock Keeping Unit (SKU) of a Durable Task Scheduler") +union SchedulerSkuName { + string, + + @doc("Dedicated SKU") + Dedicated: "Dedicated", + + @doc("Consumption SKU") + @added(Versions.v2025_04_01_Preview) + Consumption: "Consumption", +} + +@doc("The state of the resource redundancy") +union RedundancyState { + string, + + @doc("The resource is not redundant") + None: "None", + + @doc("The resource is zone redundant") + Zone: "Zone", +} + +@doc("State of the public network access.") +@added(Versions.v2026_02_01) +union PublicNetworkAccess { + string, + + @doc("The public network access is enabled") + Enabled: "Enabled", + + @doc("The public network access is disabled") + Disabled: "Disabled", +} + +@doc("The update request model for the Scheduler resource") +model SchedulerUpdate + is UpdateableProperties> { + ...ManagedServiceIdentityProperty; +} + +@@added(SchedulerUpdate.identity, Versions.v2026_05_01_Preview); + +@doc("The Scheduler resource properties to be updated") +model SchedulerPropertiesUpdate { + @visibility(Lifecycle.Read) + @doc("The status of the last operation") + provisioningState?: ProvisioningState; + + @doc("URL of the durable task scheduler") + @visibility(Lifecycle.Read) + endpoint?: string; + + @doc("IP allow list for durable task scheduler. Values can be IPv4, IPv6 or CIDR") + ipAllowlist?: string[]; + + @doc("SKU of the durable task scheduler") + sku?: SchedulerSkuUpdate; + + @added(Versions.v2026_02_01) + @doc("Allow or disallow public network access to durable task scheduler") + publicNetworkAccess?: PublicNetworkAccess; +} + +@doc("The SKU (Stock Keeping Unit) properties to be updated") +model SchedulerSkuUpdate { + @doc("The name of the SKU") + @typeChangedFrom(Versions.v2025_11_01, string) + name?: SchedulerSkuName; + + @doc("The SKU capacity. This allows scale out/in for the resource and impacts zone redundancy") + capacity?: int32; + + @doc("Indicates whether the current SKU configuration is zone redundant") + @visibility(Lifecycle.Read) + redundancyState?: RedundancyState; +} + +@armResourceOperations(Scheduler) +interface Schedulers { + @doc("Get a Scheduler") + @errorsDoc("Not found error: resource does not exist") + get is ArmResourceRead; + @doc("Create or update a Scheduler") + @errorsDoc("Validation error: required parameters are missing") + createOrUpdate is ArmResourceCreateOrReplaceAsync; + @doc("Update a Scheduler") + @errorsDoc("Validation error: required parameters are missing") + update is ArmCustomPatchAsync; + @doc("Delete a Scheduler") + delete is ArmResourceDeleteWithoutOkAsync; + @doc("List Schedulers by resource group") + listByResourceGroup is ArmResourceListByParent; + @doc("List Schedulers by subscription") + listBySubscription is ArmListBySubscription; + + @added(Versions.v2026_02_01) + @doc("Get a private link resource for the durable task scheduler") + getPrivateLink is PrivateLinkOperations.Read; + @added(Versions.v2026_02_01) + @doc("List private link resources for the durable task scheduler") + listPrivateLinks is PrivateLinkOperations.ListByParent; + + @added(Versions.v2026_02_01) + @doc("Get a private endpoint connection for the durable task scheduler") + getPrivateEndpointConnection is PrivateEndpointOperations.Read; + @added(Versions.v2026_02_01) + @doc("Create or update a private endpoint connection for the durable task scheduler") + createOrUpdatePrivateEndpointConnection is PrivateEndpointOperations.CreateOrUpdateAsync; + @added(Versions.v2026_02_01) + @doc("Update a private endpoint connection for the durable task scheduler") + updatePrivateEndpointConnection is PrivateEndpointOperations.CustomPatchAsync; + @added(Versions.v2026_02_01) + @doc("Delete a private endpoint connection for the durable task scheduler") + deletePrivateEndpointConnection is PrivateEndpointOperations.DeleteAsync; + @added(Versions.v2026_02_01) + @doc("List private endpoint connections for the durable task scheduler") + listPrivateEndpointConnections is PrivateEndpointOperations.ListByParent; + + @added(Versions.v2026_05_01_Preview) + @doc("Restart a Scheduler") + restart is ArmResourceActionSync; +} diff --git a/specification/durabletask/DurableTask.Management/taskhub.tsp b/specification/durabletask/DurableTask.Management/taskhub.tsp new file mode 100644 index 000000000000..ccb2089c657f --- /dev/null +++ b/specification/durabletask/DurableTask.Management/taskhub.tsp @@ -0,0 +1,51 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.ResourceManager; + +namespace Microsoft.DurableTask; + +@doc("A Task Hub resource belonging to the scheduler") +@added(Versions.v2024_10_01_Preview) +@parentResource(Scheduler) +model TaskHub is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + TaskHub, + "taskHubName", + "taskHubs", + "^[a-zA-Z0-9-]{3,64}$" + >; +} + +@doc("The properties of Task Hub") +model TaskHubProperties { + @visibility(Lifecycle.Read) + @doc("The status of the last operation") + provisioningState?: ProvisioningState; + + @doc("URL of the durable task scheduler dashboard") + @visibility(Lifecycle.Read) + dashboardUrl?: url; + + @added(Versions.v2026_05_01_Preview) + @doc("A set of Task Hub capabilities that can be enabled or disabled for a Task Hub") + capabilities?: string[]; +} + +@armResourceOperations(TaskHub) +interface TaskHubs { + @doc("Get a Task Hub") + @errorsDoc("Not found error: resource does not exist") + get is ArmResourceRead; + @doc("Create or Update a Task Hub") + @errorsDoc("Validation error: required parameters are missing") + createOrUpdate is ArmResourceCreateOrReplaceAsync; + @doc("Delete a Task Hub") + delete is ArmResourceDeleteWithoutOkAsync; + @doc("List Task Hubs") + listByScheduler is ArmResourceListByParent; +} diff --git a/specification/durabletask/DurableTask.Management/transparentDataEncryption.tsp b/specification/durabletask/DurableTask.Management/transparentDataEncryption.tsp new file mode 100644 index 000000000000..34a001613649 --- /dev/null +++ b/specification/durabletask/DurableTask.Management/transparentDataEncryption.tsp @@ -0,0 +1,64 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.ResourceManager; + +namespace Microsoft.DurableTask; + +@doc("A transparent data encryption resource belonging to the scheduler") +@added(Versions.v2026_05_01_Preview) +@parentResource(Scheduler) +@singleton +model TransparentDataEncryption + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + TransparentDataEncryption, + "transparentDataEncryptionName", + "transparentDataEncryptions" + >; +} + +@doc("The transparent data encryption settings for the resource") +@added(Versions.v2026_05_01_Preview) +model TransparentDataEncryptionProperties { + @visibility(Lifecycle.Read) + @doc("The status of the last operation") + provisioningState?: ProvisioningState; + + @doc("The key source for the transparent data encryption") + keySource: TransparentDataEncryptionKeySource; + + @doc("The URI of the key in Key Vault to be used for transparent data encryption") + keyVaultKeyUri?: url; +} + +@added(Versions.v2026_05_01_Preview) +@doc("The key source for the transparent data encryption") +union TransparentDataEncryptionKeySource { + string, + + @doc("The key source is Microsoft-managed") + MicrosoftManaged: "MicrosoftManaged", + + @doc("The key source is customer-managed") + CustomerManaged: "CustomerManaged", +} + +@added(Versions.v2026_05_01_Preview) +@armResourceOperations(TransparentDataEncryption) +interface TransparentDataEncryptions { + @doc("Get a Transparent Data Encryption") + @errorsDoc("Not found error: resource does not exist") + get is ArmResourceRead; + @doc("Create or Update a Transparent Data Encryption") + @errorsDoc("Validation error: required parameters are missing") + createOrReplace is ArmResourceCreateOrReplaceAsync; + @doc("Delete a Transparent Data Encryption") + delete is ArmResourceDeleteWithoutOkAsync; + @doc("List Transparent Data Encryptions") + listByScheduler is ArmResourceListByParent; +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/durabletask.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/durabletask.json new file mode 100644 index 000000000000..85f7d9db24d9 --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/durabletask.json @@ -0,0 +1,2326 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.DurableTask", + "version": "2026-05-01-preview", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Schedulers" + }, + { + "name": "TaskHubs" + }, + { + "name": "RetentionPolicies" + }, + { + "name": "TransparentDataEncryptions" + } + ], + "paths": { + "/providers/Microsoft.DurableTask/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DurableTask/schedulers": { + "get": { + "operationId": "Schedulers_ListBySubscription", + "tags": [ + "Schedulers" + ], + "description": "List Schedulers by subscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SchedulerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Schedulers_ListBySubscription": { + "$ref": "./examples/Schedulers_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers": { + "get": { + "operationId": "Schedulers_ListByResourceGroup", + "tags": [ + "Schedulers" + ], + "description": "List Schedulers by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SchedulerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Schedulers_ListByResourceGroup": { + "$ref": "./examples/Schedulers_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}": { + "get": { + "operationId": "Schedulers_Get", + "tags": [ + "Schedulers" + ], + "description": "Get a Scheduler", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Scheduler" + } + }, + "default": { + "description": "Not found error: resource does not exist", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Schedulers_Get": { + "$ref": "./examples/Schedulers_Get.json" + } + } + }, + "put": { + "operationId": "Schedulers_CreateOrUpdate", + "tags": [ + "Schedulers" + ], + "description": "Create or update a Scheduler", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Scheduler" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Scheduler' update operation succeeded", + "schema": { + "$ref": "#/definitions/Scheduler" + } + }, + "201": { + "description": "Resource 'Scheduler' create operation succeeded", + "schema": { + "$ref": "#/definitions/Scheduler" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "Validation error: required parameters are missing", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Schedulers_CreateOrUpdate": { + "$ref": "./examples/Schedulers_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Schedulers_Update", + "tags": [ + "Schedulers" + ], + "description": "Update a Scheduler", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SchedulerUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Scheduler" + } + }, + "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": "Validation error: required parameters are missing", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Schedulers_Update": { + "$ref": "./examples/Schedulers_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Schedulers_Delete", + "tags": [ + "Schedulers" + ], + "description": "Delete a Scheduler", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "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/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Schedulers_Delete": { + "$ref": "./examples/Schedulers_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/privateEndpointConnections": { + "get": { + "operationId": "Schedulers_ListPrivateEndpointConnections", + "tags": [ + "Schedulers" + ], + "description": "List private endpoint connections for the durable task scheduler", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_List_MaximumSet": { + "$ref": "./examples/PrivateEndpointConnections_List_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "operationId": "Schedulers_GetPrivateEndpointConnection", + "tags": [ + "Schedulers" + ], + "description": "Get a private endpoint connection for the durable task scheduler", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Get_MaximumSet": { + "$ref": "./examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "Schedulers_CreateOrUpdatePrivateEndpointConnection", + "tags": [ + "Schedulers" + ], + "description": "Create or update a private endpoint connection for the durable task scheduler", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Resource 'PrivateEndpointConnection' update operation succeeded", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Resource 'PrivateEndpointConnection' create operation succeeded", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Create_MaximumSet": { + "$ref": "./examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Schedulers_UpdatePrivateEndpointConnection", + "tags": [ + "Schedulers" + ], + "description": "Update a private endpoint connection for the durable task scheduler", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Azure.ResourceManager.PrivateEndpointConnectionUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "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/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Update": { + "$ref": "./examples/PrivateEndpointConnections_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Schedulers_DeletePrivateEndpointConnection", + "tags": [ + "Schedulers" + ], + "description": "Delete a private endpoint connection for the durable task scheduler", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "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/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Delete_MaximumSet": { + "$ref": "./examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/privateLinkResources": { + "get": { + "operationId": "Schedulers_ListPrivateLinks", + "tags": [ + "Schedulers" + ], + "description": "List private link resources for the durable task scheduler", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SchedulerPrivateLinkResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkResources_List_MaximumSet": { + "$ref": "./examples/PrivateLinkResources_List_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/privateLinkResources/{privateLinkResourceName}": { + "get": { + "operationId": "Schedulers_GetPrivateLink", + "tags": [ + "Schedulers" + ], + "description": "Get a private link resource for the durable task scheduler", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "privateLinkResourceName", + "in": "path", + "description": "The name of the private link associated with the Azure resource.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkResources_Get_MaximumSet": { + "$ref": "./examples/PrivateLinkResources_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/restart": { + "post": { + "operationId": "Schedulers_Restart", + "tags": [ + "Schedulers" + ], + "description": "Restart a Scheduler", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "responses": { + "204": { + "description": "Azure operation completed successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Schedulers_Restart": { + "$ref": "./examples/Schedulers_Restart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/retentionPolicies": { + "get": { + "operationId": "RetentionPolicies_ListByScheduler", + "tags": [ + "RetentionPolicies" + ], + "description": "List Retention Policies", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RetentionPolicyListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RetentionPolicies_ListByScheduler_MaximumSet": { + "$ref": "./examples/RetentionPolicies_ListByScheduler_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/retentionPolicies/default": { + "get": { + "operationId": "RetentionPolicies_Get", + "tags": [ + "RetentionPolicies" + ], + "description": "Get a Retention Policy", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RetentionPolicy" + } + }, + "default": { + "description": "Not found error: resource does not exist", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RetentionPolicies_Get_MaximumSet": { + "$ref": "./examples/RetentionPolicies_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "RetentionPolicies_CreateOrReplace", + "tags": [ + "RetentionPolicies" + ], + "description": "Create or Update a Retention Policy", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/RetentionPolicy" + } + } + ], + "responses": { + "200": { + "description": "Resource 'RetentionPolicy' update operation succeeded", + "schema": { + "$ref": "#/definitions/RetentionPolicy" + } + }, + "201": { + "description": "Resource 'RetentionPolicy' create operation succeeded", + "schema": { + "$ref": "#/definitions/RetentionPolicy" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "Validation error: required parameters are missing", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RetentionPolicies_CreateOrReplace_MaximumSet": { + "$ref": "./examples/RetentionPolicies_CreateOrReplace_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "RetentionPolicies_Update", + "tags": [ + "RetentionPolicies" + ], + "description": "Update a Retention Policy", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/RetentionPolicyUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RetentionPolicy" + } + }, + "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": "Validation error: required parameters are missing", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RetentionPolicies_Update_MaximumSet": { + "$ref": "./examples/RetentionPolicies_Update_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "RetentionPolicies_Delete", + "tags": [ + "RetentionPolicies" + ], + "description": "Delete a Retention Policy", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "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/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RetentionPolicies_Delete_MaximumSet": { + "$ref": "./examples/RetentionPolicies_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/taskHubs": { + "get": { + "operationId": "TaskHubs_ListByScheduler", + "tags": [ + "TaskHubs" + ], + "description": "List Task Hubs", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TaskHubListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TaskHubs_ListByScheduler": { + "$ref": "./examples/TaskHubs_ListByScheduler.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/taskHubs/{taskHubName}": { + "get": { + "operationId": "TaskHubs_Get", + "tags": [ + "TaskHubs" + ], + "description": "Get a Task Hub", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "taskHubName", + "in": "path", + "description": "The name of the TaskHub", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TaskHub" + } + }, + "default": { + "description": "Not found error: resource does not exist", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TaskHubs_Get": { + "$ref": "./examples/TaskHubs_Get.json" + } + } + }, + "put": { + "operationId": "TaskHubs_CreateOrUpdate", + "tags": [ + "TaskHubs" + ], + "description": "Create or Update a Task Hub", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "taskHubName", + "in": "path", + "description": "The name of the TaskHub", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TaskHub" + } + } + ], + "responses": { + "200": { + "description": "Resource 'TaskHub' update operation succeeded", + "schema": { + "$ref": "#/definitions/TaskHub" + } + }, + "201": { + "description": "Resource 'TaskHub' create operation succeeded", + "schema": { + "$ref": "#/definitions/TaskHub" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "Validation error: required parameters are missing", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TaskHubs_CreateOrUpdate": { + "$ref": "./examples/TaskHubs_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "TaskHubs_Delete", + "tags": [ + "TaskHubs" + ], + "description": "Delete a Task Hub", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "taskHubName", + "in": "path", + "description": "The name of the TaskHub", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "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/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TaskHubs_Delete": { + "$ref": "./examples/TaskHubs_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/transparentDataEncryptions": { + "get": { + "operationId": "TransparentDataEncryptions_ListByScheduler", + "tags": [ + "TransparentDataEncryptions" + ], + "description": "List Transparent Data Encryptions", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TransparentDataEncryptionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransparentDataEncryptions_ListByScheduler_MaximumSet": { + "$ref": "./examples/TransparentDataEncryptions_ListByScheduler_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/transparentDataEncryptions/default": { + "get": { + "operationId": "TransparentDataEncryptions_Get", + "tags": [ + "TransparentDataEncryptions" + ], + "description": "Get a Transparent Data Encryption", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TransparentDataEncryption" + } + }, + "default": { + "description": "Not found error: resource does not exist", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransparentDataEncryptions_Get_MaximumSet": { + "$ref": "./examples/TransparentDataEncryptions_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "TransparentDataEncryptions_CreateOrReplace", + "tags": [ + "TransparentDataEncryptions" + ], + "description": "Create or Update a Transparent Data Encryption", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TransparentDataEncryption" + } + } + ], + "responses": { + "200": { + "description": "Resource 'TransparentDataEncryption' update operation succeeded", + "schema": { + "$ref": "#/definitions/TransparentDataEncryption" + } + }, + "201": { + "description": "Resource 'TransparentDataEncryption' create operation succeeded", + "schema": { + "$ref": "#/definitions/TransparentDataEncryption" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "Validation error: required parameters are missing", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransparentDataEncryptions_CreateOrReplace_MaximumSet": { + "$ref": "./examples/TransparentDataEncryptions_CreateOrReplace_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "TransparentDataEncryptions_Delete", + "tags": [ + "TransparentDataEncryptions" + ], + "description": "Delete a Transparent Data Encryption", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "schedulerName", + "in": "path", + "description": "The name of the Scheduler", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "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/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransparentDataEncryptions_Delete_MaximumSet": { + "$ref": "./examples/TransparentDataEncryptions_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "Azure.ResourceManager.PrivateEndpointConnectionUpdate": { + "type": "object", + "description": "PATCH model for private endpoint connections", + "properties": { + "properties": { + "type": "object", + "description": "The private endpoint connection properties", + "properties": { + "privateEndpoint": { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpoint", + "description": "The private endpoint resource." + }, + "privateLinkServiceConnectionState": { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + } + } + } + } + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "The response of a PrivateEndpointConnection list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateEndpointConnection items on this page", + "items": { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "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": "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" + } + ] + }, + "readOnly": true + }, + "PublicNetworkAccess": { + "type": "string", + "description": "State of the public network access.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The public network access is enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The public network access is disabled" + } + ] + } + }, + "PurgeableOrchestrationState": { + "type": "string", + "description": "Purgeable orchestration state to be used in retention policies", + "enum": [ + "Completed", + "Failed", + "Terminated", + "Canceled" + ], + "x-ms-enum": { + "name": "PurgeableOrchestrationState", + "modelAsString": true, + "values": [ + { + "name": "Completed", + "value": "Completed", + "description": "The orchestration is completed" + }, + { + "name": "Failed", + "value": "Failed", + "description": "The orchestration is failed" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "The orchestration is terminated" + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "The orchestration is canceled" + } + ] + } + }, + "RedundancyState": { + "type": "string", + "description": "The state of the resource redundancy", + "enum": [ + "None", + "Zone" + ], + "x-ms-enum": { + "name": "RedundancyState", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "The resource is not redundant" + }, + { + "name": "Zone", + "value": "Zone", + "description": "The resource is zone redundant" + } + ] + } + }, + "RetentionPolicy": { + "type": "object", + "description": "A retention policy resource belonging to the scheduler", + "properties": { + "properties": { + "$ref": "#/definitions/RetentionPolicyProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "RetentionPolicyDetails": { + "type": "object", + "description": "The properties of a retention policy", + "properties": { + "retentionPeriodInDays": { + "type": "integer", + "format": "int32", + "description": "The retention period in days after which the orchestration will be purged automatically" + }, + "orchestrationState": { + "$ref": "#/definitions/PurgeableOrchestrationState", + "description": "The orchestration state to which this policy applies. If omitted, the policy applies to all purgeable orchestration states." + } + }, + "required": [ + "retentionPeriodInDays" + ] + }, + "RetentionPolicyListResult": { + "type": "object", + "description": "The response of a RetentionPolicy list operation.", + "properties": { + "value": { + "type": "array", + "description": "The RetentionPolicy items on this page", + "items": { + "$ref": "#/definitions/RetentionPolicy" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "RetentionPolicyProperties": { + "type": "object", + "description": "The retention policy settings for the resource", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation", + "readOnly": true + }, + "retentionPolicies": { + "type": "array", + "description": "The orchestration retention policies", + "items": { + "$ref": "#/definitions/RetentionPolicyDetails" + }, + "x-ms-identifiers": [ + "retentionPeriodInDays", + "orchestrationState" + ] + } + } + }, + "RetentionPolicyUpdate": { + "type": "object", + "description": "A retention policy resource belonging to the scheduler", + "properties": { + "properties": { + "$ref": "#/definitions/RetentionPolicyProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "Scheduler": { + "type": "object", + "description": "A Durable Task Scheduler resource", + "properties": { + "properties": { + "$ref": "#/definitions/SchedulerProperties", + "description": "The resource-specific properties for this resource." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" + } + ] + }, + "SchedulerListResult": { + "type": "object", + "description": "The response of a Scheduler list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Scheduler items on this page", + "items": { + "$ref": "#/definitions/Scheduler" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SchedulerPrivateLinkResourceListResult": { + "type": "object", + "description": "The response of a SchedulerPrivateLinkResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SchedulerPrivateLinkResource items on this page", + "items": { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SchedulerProperties": { + "type": "object", + "description": "Details of the Scheduler", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation", + "readOnly": true + }, + "endpoint": { + "type": "string", + "description": "URL of the durable task scheduler", + "readOnly": true + }, + "ipAllowlist": { + "type": "array", + "description": "IP allow list for durable task scheduler. Values can be IPv4, IPv6 or CIDR", + "items": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/SchedulerSku", + "description": "SKU of the durable task scheduler" + }, + "publicNetworkAccess": { + "$ref": "#/definitions/PublicNetworkAccess", + "description": "Allow or disallow public network access to durable task scheduler" + }, + "privateEndpointConnections": { + "type": "array", + "description": "The private endpoints exposed by this resource", + "items": { + "$ref": "../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + } + }, + "required": [ + "ipAllowlist", + "sku" + ] + }, + "SchedulerPropertiesUpdate": { + "type": "object", + "description": "The Scheduler resource properties to be updated", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation", + "readOnly": true + }, + "endpoint": { + "type": "string", + "description": "URL of the durable task scheduler", + "readOnly": true + }, + "ipAllowlist": { + "type": "array", + "description": "IP allow list for durable task scheduler. Values can be IPv4, IPv6 or CIDR", + "items": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/SchedulerSkuUpdate", + "description": "SKU of the durable task scheduler" + }, + "publicNetworkAccess": { + "$ref": "#/definitions/PublicNetworkAccess", + "description": "Allow or disallow public network access to durable task scheduler" + } + } + }, + "SchedulerSku": { + "type": "object", + "description": "The SKU (Stock Keeping Unit) assigned to this durable task scheduler", + "properties": { + "name": { + "$ref": "#/definitions/SchedulerSkuName", + "description": "The name of the SKU" + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "The SKU capacity. This allows scale out/in for the resource and impacts zone redundancy" + }, + "redundancyState": { + "$ref": "#/definitions/RedundancyState", + "description": "Indicates whether the current SKU configuration is zone redundant", + "readOnly": true + } + }, + "required": [ + "name" + ] + }, + "SchedulerSkuName": { + "type": "string", + "description": "The name of the Stock Keeping Unit (SKU) of a Durable Task Scheduler", + "enum": [ + "Dedicated", + "Consumption" + ], + "x-ms-enum": { + "name": "SchedulerSkuName", + "modelAsString": true, + "values": [ + { + "name": "Dedicated", + "value": "Dedicated", + "description": "Dedicated SKU" + }, + { + "name": "Consumption", + "value": "Consumption", + "description": "Consumption SKU" + } + ] + } + }, + "SchedulerSkuUpdate": { + "type": "object", + "description": "The SKU (Stock Keeping Unit) properties to be updated", + "properties": { + "name": { + "$ref": "#/definitions/SchedulerSkuName", + "description": "The name of the SKU" + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "The SKU capacity. This allows scale out/in for the resource and impacts zone redundancy" + }, + "redundancyState": { + "$ref": "#/definitions/RedundancyState", + "description": "Indicates whether the current SKU configuration is zone redundant", + "readOnly": true + } + } + }, + "SchedulerUpdate": { + "type": "object", + "description": "The update request model for the Scheduler resource", + "properties": { + "properties": { + "$ref": "#/definitions/SchedulerPropertiesUpdate", + "description": "The resource-specific properties for this resource." + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + } + }, + "TaskHub": { + "type": "object", + "description": "A Task Hub resource belonging to the scheduler", + "properties": { + "properties": { + "$ref": "#/definitions/TaskHubProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "TaskHubListResult": { + "type": "object", + "description": "The response of a TaskHub list operation.", + "properties": { + "value": { + "type": "array", + "description": "The TaskHub items on this page", + "items": { + "$ref": "#/definitions/TaskHub" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "TaskHubProperties": { + "type": "object", + "description": "The properties of Task Hub", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation", + "readOnly": true + }, + "dashboardUrl": { + "type": "string", + "format": "uri", + "description": "URL of the durable task scheduler dashboard", + "readOnly": true + }, + "capabilities": { + "type": "array", + "description": "A set of Task Hub capabilities that can be enabled or disabled for a Task Hub", + "items": { + "type": "string" + } + } + } + }, + "TransparentDataEncryption": { + "type": "object", + "description": "A transparent data encryption resource belonging to the scheduler", + "properties": { + "properties": { + "$ref": "#/definitions/TransparentDataEncryptionProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "TransparentDataEncryptionKeySource": { + "type": "string", + "description": "The key source for the transparent data encryption", + "enum": [ + "MicrosoftManaged", + "CustomerManaged" + ], + "x-ms-enum": { + "name": "TransparentDataEncryptionKeySource", + "modelAsString": true, + "values": [ + { + "name": "MicrosoftManaged", + "value": "MicrosoftManaged", + "description": "The key source is Microsoft-managed" + }, + { + "name": "CustomerManaged", + "value": "CustomerManaged", + "description": "The key source is customer-managed" + } + ] + } + }, + "TransparentDataEncryptionListResult": { + "type": "object", + "description": "The response of a TransparentDataEncryption list operation.", + "properties": { + "value": { + "type": "array", + "description": "The TransparentDataEncryption items on this page", + "items": { + "$ref": "#/definitions/TransparentDataEncryption" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "TransparentDataEncryptionProperties": { + "type": "object", + "description": "The transparent data encryption settings for the resource", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation", + "readOnly": true + }, + "keySource": { + "$ref": "#/definitions/TransparentDataEncryptionKeySource", + "description": "The key source for the transparent data encryption" + }, + "keyVaultKeyUri": { + "type": "string", + "format": "uri", + "description": "The URI of the key in Key Vault to be used for transparent data encryption" + } + }, + "required": [ + "keySource" + ] + } + }, + "parameters": {} +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Operations_List.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..7897681644f8 --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Operations_List.json @@ -0,0 +1,36 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2026-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "display": { + "description": "Create or Update Durable Task Scheduler", + "operation": "Create or Update Durable Task Scheduler", + "provider": "Durable Task Scheduler", + "resource": "Scheduler" + }, + "isDataAction": false, + "name": "Microsoft.DurableTask/schedulers/write" + }, + { + "display": { + "description": "Delete Durable Task Scheduler", + "operation": "Delete Durable Task Scheduler", + "provider": "Durable Task Scheduler", + "resource": "Scheduler" + }, + "isDataAction": false, + "name": "Microsoft.DurableTask/schedulers/delete" + } + ], + "nextLink": "https://microsoft.com/akpblld" + } + } + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..d211534a419e --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json @@ -0,0 +1,84 @@ +{ + "title": "PrivateEndpointConnections_Create_MaximumSet", + "operationId": "Schedulers_CreateOrUpdatePrivateEndpointConnection", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "851A7597-D699-45CC-899B-7487A5B3B775", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler", + "privateEndpointConnectionName": "spzckqrbhfnabu", + "resource": { + "properties": { + "privateEndpoint": {}, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "mxymqfbbmpwjxsroldlsd", + "description": "ujdcsoyxljivwsgfkexhotaxcmzq" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "vjjxatyilmgjaervqztrmlpfodvbo" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "mxymqfbbmpwjxsroldlsd", + "description": "ujdcsoyxljivwsgfkexhotaxcmzq" + }, + "groupIds": [ + "xnnrzmowptxnijdojrntrbm" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/851A7597-D699-45CC-899B-7487A5B3B775/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/privateEndpointConnections/spzckqrbhfnabu", + "name": "spzckqrbhfnabu", + "type": "Microsoft.DurableTask/schedulers/privateEndpointConnections", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "privateEndpoint": { + "id": "vjjxatyilmgjaervqztrmlpfodvbo" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "mxymqfbbmpwjxsroldlsd", + "description": "ujdcsoyxljivwsgfkexhotaxcmzq" + }, + "groupIds": [ + "xnnrzmowptxnijdojrntrbm" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/851A7597-D699-45CC-899B-7487A5B3B775/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/privateEndpointConnections/spzckqrbhfnabu", + "name": "spzckqrbhfnabu", + "type": "Microsoft.DurableTask/schedulers/privateEndpointConnections", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + } + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..13e7d8234329 --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "PrivateEndpointConnections_Delete_MaximumSet", + "operationId": "Schedulers_DeletePrivateEndpointConnection", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "851A7597-D699-45CC-899B-7487A5B3B775", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler", + "privateEndpointConnectionName": "spzckqrbhfnabu" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b65023a271f7 --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "PrivateEndpointConnections_Get_MaximumSet", + "operationId": "Schedulers_GetPrivateEndpointConnection", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "851A7597-D699-45CC-899B-7487A5B3B775", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler", + "privateEndpointConnectionName": "spzckqrbhfnabu" + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "vjjxatyilmgjaervqztrmlpfodvbo" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "mxymqfbbmpwjxsroldlsd", + "description": "ujdcsoyxljivwsgfkexhotaxcmzq" + }, + "groupIds": [ + "xnnrzmowptxnijdojrntrbm" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/851A7597-D699-45CC-899B-7487A5B3B775/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/privateEndpointConnections/spzckqrbhfnabu", + "name": "spzckqrbhfnabu", + "type": "Microsoft.DurableTask/schedulers/privateEndpointConnections", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + } + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateEndpointConnections_List_MaximumSet_Gen.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateEndpointConnections_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..298786fe4980 --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateEndpointConnections_List_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "PrivateEndpointConnections_List_MaximumSet", + "operationId": "Schedulers_ListPrivateEndpointConnections", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "851A7597-D699-45CC-899B-7487A5B3B775", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "privateEndpoint": { + "id": "vjjxatyilmgjaervqztrmlpfodvbo" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "mxymqfbbmpwjxsroldlsd", + "description": "ujdcsoyxljivwsgfkexhotaxcmzq" + }, + "groupIds": [ + "xnnrzmowptxnijdojrntrbm" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/851A7597-D699-45CC-899B-7487A5B3B775/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/privateEndpointConnections/spzckqrbhfnabu", + "name": "spzckqrbhfnabu", + "type": "Microsoft.DurableTask/schedulers/privateEndpointConnections", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + ], + "nextLink": "https://microsoft.com/anend" + } + } + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateEndpointConnections_Update.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateEndpointConnections_Update.json new file mode 100644 index 000000000000..471882439121 --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateEndpointConnections_Update.json @@ -0,0 +1,54 @@ +{ + "title": "PrivateEndpointConnections_Update", + "operationId": "Schedulers_UpdatePrivateEndpointConnection", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "851A7597-D699-45CC-899B-7487A5B3B775", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler", + "privateEndpointConnectionName": "spzckqrbhfnabu", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "vjjxatyilmgjaervqztrmlpfodvbo" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "mxymqfbbmpwjxsroldlsd", + "description": "ujdcsoyxljivwsgfkexhotaxcmzq" + }, + "groupIds": [ + "xnnrzmowptxnijdojrntrbm" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/851A7597-D699-45CC-899B-7487A5B3B775/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/privateEndpointConnections/spzckqrbhfnabu", + "name": "spzckqrbhfnabu", + "type": "Microsoft.DurableTask/schedulers/privateEndpointConnections", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateLinkResources_Get_MaximumSet_Gen.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateLinkResources_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..62cc6b54b7fb --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateLinkResources_Get_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "PrivateLinkResources_Get_MaximumSet", + "operationId": "Schedulers_GetPrivateLink", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "851A7597-D699-45CC-899B-7487A5B3B775", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler", + "privateLinkResourceName": "ulbdiqhrmwnkejje" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "mexetpneryldlrtmuxzxhwezfjkcvr", + "requiredMembers": [ + "ftzshharzmwhcemnbdwlmyhtxkpa" + ], + "requiredZoneNames": [ + "lkwwgycaduib" + ] + }, + "id": "/subscriptions/851A7597-D699-45CC-899B-7487A5B3B775/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/privateLinkResources/ulbdiqhrmwnkejje", + "name": "ulbdiqhrmwnkejje", + "type": "Microsoft.DurableTask/schedulers/privateLinkResources", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + } + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateLinkResources_List_MaximumSet_Gen.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateLinkResources_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..4c41f51eb468 --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/PrivateLinkResources_List_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "PrivateLinkResources_List_MaximumSet", + "operationId": "Schedulers_ListPrivateLinks", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "851A7597-D699-45CC-899B-7487A5B3B775", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "mexetpneryldlrtmuxzxhwezfjkcvr", + "requiredMembers": [ + "ftzshharzmwhcemnbdwlmyhtxkpa" + ], + "requiredZoneNames": [ + "lkwwgycaduib" + ] + }, + "id": "/subscriptions/851A7597-D699-45CC-899B-7487A5B3B775/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/privateLinkResources/ulbdiqhrmwnkejje", + "name": "ulbdiqhrmwnkejje", + "type": "Microsoft.DurableTask/schedulers/privateLinkResources", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/RetentionPolicies_CreateOrReplace_MaximumSet_Gen.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/RetentionPolicies_CreateOrReplace_MaximumSet_Gen.json new file mode 100644 index 000000000000..77079cdc0775 --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/RetentionPolicies_CreateOrReplace_MaximumSet_Gen.json @@ -0,0 +1,83 @@ +{ + "title": "RetentionPolicies_CreateOrReplace_MaximumSet", + "operationId": "RetentionPolicies_CreateOrReplace", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "194D3C1E-462F-4738-9025-092A628C06EB", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler", + "retentionPolicyName": "default", + "resource": { + "properties": { + "retentionPolicies": [ + { + "retentionPeriodInDays": 30 + }, + { + "retentionPeriodInDays": 10, + "orchestrationState": "Failed" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "retentionPolicies": [ + { + "retentionPeriodInDays": 30 + }, + { + "retentionPeriodInDays": 10, + "orchestrationState": "Failed" + } + ] + }, + "id": "/subscriptions/194D3C1E-462F-4738-9025-092A628C06EB/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/retentionPolicies/default", + "name": "default", + "type": "Microsoft.DurableTask/schedulers/retentionPolicies", + "systemData": { + "createdBy": "zshkmc", + "createdByType": "User", + "createdAt": "2025-03-31T23:34:09.612Z", + "lastModifiedBy": "ivqrae", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-03-31T23:34:09.612Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "retentionPolicies": [ + { + "retentionPeriodInDays": 30 + }, + { + "retentionPeriodInDays": 10, + "orchestrationState": "Failed" + } + ] + }, + "id": "/subscriptions/194D3C1E-462F-4738-9025-092A628C06EB/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/retentionPolicies/default", + "name": "default", + "type": "Microsoft.DurableTask/schedulers/retentionPolicies", + "systemData": { + "createdBy": "zshkmc", + "createdByType": "User", + "createdAt": "2025-03-31T23:34:09.612Z", + "lastModifiedBy": "ivqrae", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-03-31T23:34:09.612Z" + } + } + } + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/RetentionPolicies_Delete_MaximumSet_Gen.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/RetentionPolicies_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..cd5d22441601 --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/RetentionPolicies_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "RetentionPolicies_Delete_MaximumSet", + "operationId": "RetentionPolicies_Delete", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "194D3C1E-462F-4738-9025-092A628C06EB", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testcheduler", + "retentionPolicyName": "default" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/RetentionPolicies_Get_MaximumSet_Gen.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/RetentionPolicies_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..9fd66c899cd6 --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/RetentionPolicies_Get_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "RetentionPolicies_Get_MaximumSet", + "operationId": "RetentionPolicies_Get", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "194D3C1E-462F-4738-9025-092A628C06EB", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler", + "retentionPolicyName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "retentionPolicies": [ + { + "retentionPeriodInDays": 30 + }, + { + "retentionPeriodInDays": 10, + "orchestrationState": "Failed" + } + ] + }, + "id": "/subscriptions/194D3C1E-462F-4738-9025-092A628C06EB/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/retentionPolicies/default", + "name": "default", + "type": "Microsoft.DurableTask/schedulers/retentionPolicies", + "systemData": { + "createdBy": "zshkmc", + "createdByType": "User", + "createdAt": "2025-03-31T23:34:09.612Z", + "lastModifiedBy": "ivqrae", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-03-31T23:34:09.612Z" + } + } + } + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/RetentionPolicies_ListByScheduler_MaximumSet_Gen.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/RetentionPolicies_ListByScheduler_MaximumSet_Gen.json new file mode 100644 index 000000000000..547dc718b4d7 --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/RetentionPolicies_ListByScheduler_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "RetentionPolicies_ListByScheduler_MaximumSet", + "operationId": "RetentionPolicies_ListByScheduler", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "194D3C1E-462F-4738-9025-092A628C06EB", + "resourceGroupName": "rgdurabletask", + "schedulerName": "myscheduler" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "retentionPolicies": [ + { + "retentionPeriodInDays": 30 + }, + { + "retentionPeriodInDays": 10, + "orchestrationState": "Failed" + } + ] + }, + "id": "/subscriptions/194D3C1E-462F-4738-9025-092A628C06EB/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/retentionPolicies/default", + "name": "default", + "type": "Microsoft.DurableTask/schedulers/retentionPolicies", + "systemData": { + "createdBy": "zshkmc", + "createdByType": "User", + "createdAt": "2025-03-31T23:34:09.612Z", + "lastModifiedBy": "ivqrae", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-03-31T23:34:09.612Z" + } + } + ], + "nextLink": "https://microsoft.com/ai" + } + } + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/RetentionPolicies_Update_MaximumSet_Gen.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/RetentionPolicies_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..3784113156ed --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/RetentionPolicies_Update_MaximumSet_Gen.json @@ -0,0 +1,65 @@ +{ + "title": "RetentionPolicies_Update_MaximumSet", + "operationId": "RetentionPolicies_Update", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "194D3C1E-462F-4738-9025-092A628C06EB", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler", + "retentionPolicyName": "default", + "properties": { + "properties": { + "retentionPolicies": [ + { + "retentionPeriodInDays": 30 + }, + { + "retentionPeriodInDays": 10, + "orchestrationState": "Failed" + }, + { + "retentionPeriodInDays": 24, + "orchestrationState": "Completed" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "retentionPolicies": [ + { + "retentionPeriodInDays": 30 + }, + { + "retentionPeriodInDays": 10, + "orchestrationState": "Failed" + }, + { + "retentionPeriodInDays": 24, + "orchestrationState": "Completed" + } + ] + }, + "id": "/subscriptions/194D3C1E-462F-4738-9025-092A628C06EB/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/retentionPolicies/default", + "name": "default", + "type": "Microsoft.DurableTask/schedulers/retentionPolicies", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_CreateOrUpdate.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_CreateOrUpdate.json new file mode 100644 index 000000000000..633f9f3b79fc --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_CreateOrUpdate.json @@ -0,0 +1,106 @@ +{ + "title": "Schedulers_CreateOrUpdate", + "operationId": "Schedulers_CreateOrUpdate", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgopenapi", + "schedulerName": "testscheduler", + "resource": { + "location": "northcentralus", + "properties": { + "ipAllowlist": [ + "10.0.0.0/8" + ], + "sku": { + "name": "Dedicated" + } + }, + "tags": { + "department": "research", + "development": "true" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "northcentralus", + "properties": { + "provisioningState": "Succeeded", + "endpoint": "https://test.northcentralus.1.durabletask.io", + "ipAllowlist": [ + "10.0.0.0/8" + ], + "sku": { + "name": "Dedicated", + "capacity": 3, + "redundancyState": "Zone" + } + }, + "tags": { + "department": "research", + "development": "true" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": {} + } + }, + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler", + "name": "testscheduler", + "type": "Microsoft.DurableTask/schedulers", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "location": "northcentralus", + "properties": { + "provisioningState": "Succeeded", + "endpoint": "https://test.northcentralus.1.durabletask.io", + "ipAllowlist": [ + "10.0.0.0/8" + ], + "sku": { + "name": "Dedicated", + "capacity": 3, + "redundancyState": "Zone" + } + }, + "tags": { + "department": "research", + "development": "true" + }, + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler", + "name": "testscheduler", + "type": "Microsoft.DurableTask/schedulers", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + } + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_Delete.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_Delete.json new file mode 100644 index 000000000000..23d0d162c99f --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Schedulers_Delete", + "operationId": "Schedulers_Delete", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgopenapi", + "schedulerName": "testscheduler" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_Get.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_Get.json new file mode 100644 index 000000000000..fc307bad65f4 --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_Get.json @@ -0,0 +1,46 @@ +{ + "title": "Schedulers_Get", + "operationId": "Schedulers_Get", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgopenapi", + "schedulerName": "testscheduler" + }, + "responses": { + "200": { + "body": { + "location": "northcentralus", + "properties": { + "provisioningState": "Succeeded", + "endpoint": "https://test.northcentralus.1.durabletask.io", + "ipAllowlist": [ + "10.0.0.0/8" + ], + "sku": { + "name": "Dedicated", + "capacity": 3, + "redundancyState": "Zone" + }, + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [] + }, + "tags": { + "department": "research", + "development": "true" + }, + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler", + "name": "testscheduler", + "type": "Microsoft.DurableTask/schedulers", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + } + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_ListByResourceGroup.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_ListByResourceGroup.json new file mode 100644 index 000000000000..6636c137f5c1 --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_ListByResourceGroup.json @@ -0,0 +1,50 @@ +{ + "title": "Schedulers_ListByResourceGroup", + "operationId": "Schedulers_ListByResourceGroup", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgopenapi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler", + "location": "northcentralus", + "properties": { + "provisioningState": "Succeeded", + "endpoint": "https://test.northcentralus.1.durabletask.io", + "ipAllowlist": [ + "10.0.0.0/8" + ], + "sku": { + "name": "Dedicated", + "capacity": 3, + "redundancyState": "Zone" + }, + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [] + }, + "tags": { + "department": "research", + "development": "true" + }, + "name": "testscheduler", + "type": "Microsoft.DurableTask/schedulers", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_ListBySubscription.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_ListBySubscription.json new file mode 100644 index 000000000000..74d67623d0d9 --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_ListBySubscription.json @@ -0,0 +1,49 @@ +{ + "title": "Schedulers_ListBySubscription", + "operationId": "Schedulers_ListBySubscription", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler", + "location": "northcentralus", + "properties": { + "provisioningState": "Succeeded", + "endpoint": "https://test.northcentralus.1.durabletask.io", + "ipAllowlist": [ + "10.0.0.0/8" + ], + "sku": { + "name": "Dedicated", + "capacity": 3, + "redundancyState": "Zone" + }, + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [] + }, + "tags": { + "department": "research", + "development": "true" + }, + "name": "testscheduler", + "type": "Microsoft.DurableTask/schedulers", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_Restart.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_Restart.json new file mode 100644 index 000000000000..935d4236d3b4 --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_Restart.json @@ -0,0 +1,13 @@ +{ + "title": "Schedulers_Restart", + "operationId": "Schedulers_Restart", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgopenapi", + "schedulerName": "testscheduler" + }, + "responses": { + "204": {} + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_Update.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_Update.json new file mode 100644 index 000000000000..84fa53a9f62b --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/Schedulers_Update.json @@ -0,0 +1,70 @@ +{ + "title": "Schedulers_Update", + "operationId": "Schedulers_Update", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgopenapi", + "schedulerName": "testscheduler", + "properties": { + "tags": { + "hello": "world" + }, + "properties": { + "ipAllowlist": [ + "10.0.0.0/8" + ], + "sku": { + "name": "Dedicated", + "capacity": 3 + } + }, + "identity": { + "type": "None" + } + } + }, + "responses": { + "200": { + "body": { + "location": "northcentralus", + "properties": { + "provisioningState": "Succeeded", + "endpoint": "https://test.northcentralus.1.durabletask.io", + "ipAllowlist": [ + "10.0.0.0/8" + ], + "sku": { + "name": "Dedicated", + "capacity": 3, + "redundancyState": "Zone" + } + }, + "tags": { + "department": "research", + "development": "true", + "hello": "world" + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler", + "name": "testscheduler", + "type": "Microsoft.DurableTask/schedulers", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TaskHubs_CreateOrUpdate.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TaskHubs_CreateOrUpdate.json new file mode 100644 index 000000000000..9380833825c5 --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TaskHubs_CreateOrUpdate.json @@ -0,0 +1,64 @@ +{ + "title": "TaskHubs_CreateOrUpdate", + "operationId": "TaskHubs_CreateOrUpdate", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgopenapi", + "schedulerName": "testscheduler", + "taskHubName": "testtaskhub", + "resource": { + "properties": { + "capabilities": [ + "ExampleFutureCapability" + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "dashboardUrl": "https://test-db.northcentralus.1.durabletask.io/taskhubs/testtaskhub", + "capabilities": [ + "ExampleFutureCapability" + ] + }, + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler/taskHubs/testtaskhub", + "name": "testtaskhub", + "type": "Microsoft.DurableTask/schedulers/taskHubs", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "dashboardUrl": "https://test-db.northcentralus.1.durabletask.io/taskhubs/testtaskhub", + "capabilities": [ + "ExampleFutureCapability" + ] + }, + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler/taskHubs/testtaskhub", + "name": "testtaskhub", + "type": "Microsoft.DurableTask/schedulers/taskHubs", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + } + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TaskHubs_Delete.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TaskHubs_Delete.json new file mode 100644 index 000000000000..0aac04818901 --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TaskHubs_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "TaskHubs_Delete", + "operationId": "TaskHubs_Delete", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgopenapi", + "schedulerName": "testscheduler", + "taskHubName": "testtaskhub" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TaskHubs_Get.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TaskHubs_Get.json new file mode 100644 index 000000000000..90a41f2a1c31 --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TaskHubs_Get.json @@ -0,0 +1,32 @@ +{ + "title": "TaskHubs_Get", + "operationId": "TaskHubs_Get", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgopenapi", + "schedulerName": "testscheduler", + "taskHubName": "testtaskhub" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "dashboardUrl": "https://test-db.northcentralus.1.durabletask.io/taskhubs/testtaskhub" + }, + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler/taskHubs/testtaskhub", + "name": "testtaskhub", + "type": "Microsoft.DurableTask/schedulers/taskHubs", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + } + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TaskHubs_ListByScheduler.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TaskHubs_ListByScheduler.json new file mode 100644 index 000000000000..51e1fd101282 --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TaskHubs_ListByScheduler.json @@ -0,0 +1,36 @@ +{ + "title": "TaskHubs_ListByScheduler", + "operationId": "TaskHubs_ListByScheduler", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgopenapi", + "schedulerName": "testscheduler" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler/taskHubs/testtaskhub", + "properties": { + "provisioningState": "Succeeded", + "dashboardUrl": "https://test-db.northcentralus.1.durabletask.io/taskhubs/testtaskhub" + }, + "name": "testtaskhub", + "type": "Microsoft.DurableTask/schedulers/taskHubs", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TransparentDataEncryptions_CreateOrReplace_MaximumSet_Gen.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TransparentDataEncryptions_CreateOrReplace_MaximumSet_Gen.json new file mode 100644 index 000000000000..bbc2fbf5c1f8 --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TransparentDataEncryptions_CreateOrReplace_MaximumSet_Gen.json @@ -0,0 +1,61 @@ +{ + "title": "TransparentDataEncryptions_CreateOrReplace_MaximumSet", + "operationId": "TransparentDataEncryptions_CreateOrReplace", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler", + "resource": { + "properties": { + "keySource": "CustomerManaged", + "keyVaultKeyUri": "https://microsoft.com/ap" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "keySource": "CustomerManaged", + "keyVaultKeyUri": "https://microsoft.com/ap" + }, + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/transparentDataEncryptions/default", + "name": "default", + "type": "Microsoft.DurableTask/schedulers/transparentDataEncryptions", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "keySource": "CustomerManaged", + "keyVaultKeyUri": "https://microsoft.com/ap" + }, + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/transparentDataEncryptions/default", + "name": "default", + "type": "Microsoft.DurableTask/schedulers/transparentDataEncryptions", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + } + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TransparentDataEncryptions_Delete_MaximumSet_Gen.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TransparentDataEncryptions_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..7fb383504e46 --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TransparentDataEncryptions_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "TransparentDataEncryptions_Delete_MaximumSet", + "operationId": "TransparentDataEncryptions_Delete", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TransparentDataEncryptions_Get_MaximumSet_Gen.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TransparentDataEncryptions_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..4dd395e082a6 --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TransparentDataEncryptions_Get_MaximumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "title": "TransparentDataEncryptions_Get_MaximumSet", + "operationId": "TransparentDataEncryptions_Get", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "keySource": "CustomerManaged", + "keyVaultKeyUri": "https://microsoft.com/ap" + }, + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/transparentDataEncryptions/default", + "name": "default", + "type": "Microsoft.DurableTask/schedulers/transparentDataEncryptions", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + } + } +} diff --git a/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TransparentDataEncryptions_ListByScheduler_MaximumSet_Gen.json b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TransparentDataEncryptions_ListByScheduler_MaximumSet_Gen.json new file mode 100644 index 000000000000..586315516953 --- /dev/null +++ b/specification/durabletask/resource-manager/Microsoft.DurableTask/preview/2026-05-01-preview/examples/TransparentDataEncryptions_ListByScheduler_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "TransparentDataEncryptions_ListByScheduler_MaximumSet", + "operationId": "TransparentDataEncryptions_ListByScheduler", + "parameters": { + "api-version": "2026-05-01-preview", + "subscriptionId": "EE9BD735-67CE-4A90-89C4-439D3F6A4C93", + "resourceGroupName": "rgdurabletask", + "schedulerName": "testscheduler" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "keySource": "CustomerManaged", + "keyVaultKeyUri": "https://microsoft.com/ap" + }, + "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/transparentDataEncryptions/default", + "name": "default", + "type": "Microsoft.DurableTask/schedulers/transparentDataEncryptions", + "systemData": { + "createdBy": "tenmbevaunjzikxowqexrsx", + "createdByType": "User", + "createdAt": "2024-04-17T15:34:17.365Z", + "lastModifiedBy": "xfvdcegtj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-17T15:34:17.366Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/durabletask/resource-manager/readme.md b/specification/durabletask/resource-manager/readme.md index 3fb2bbe73cb7..201ff60de960 100644 --- a/specification/durabletask/resource-manager/readme.md +++ b/specification/durabletask/resource-manager/readme.md @@ -27,7 +27,55 @@ These are the global settings for the durabletask. ```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2026-02-01 +tag: package-2026-05-01-preview +``` + +### Tag: package-2026-05-01-preview + +These settings apply only when `--tag=package-2026-05-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2026-05-01-preview' +input-file: + - Microsoft.DurableTask/preview/2026-05-01-preview/durabletask.json +suppressions: + - code: ArmResourcePropertiesBag + reason: Changing this property would constitute a breaking change. SKU property was approved in previous API versions. + from: + - durabletask.json + where: + - $.definitions.Scheduler + - $.definitions.SchedulerUpdate + - $.definitions.Scheduler.properties.sku + - $.definitions.Scheduler.properties.properties.sku + - $.definitions.SchedulerUpdate.properties.sku + - $.definition.SchedulerUpdate.properties.properties.sku + - $.definitions.SchedulerListResult + - $.definitions.SchedulerSku + - $.definitions.SchedulerSkuUpdate + - $.definitions.Scheduler.properties + - $.definitions.SchedulerUpdate.properties + - $.definitions.SchedulerProperties + - $.definitions.SchedulerPropertiesUpdate + - $.definitions.SchedulerProperties.properties + - $.definitions.SchedulerPropertiesUpdate.properties + - code: XMSSecretInResponse + reason: publicNetworkAccess is not a secret - it is a network configuration setting that controls public endpoint access. + from: + - durabletask.json + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}"].put.responses["200"].schema.properties.properties.properties.publicNetworkAccess + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}"].put.responses["201"].schema.properties.properties.properties.publicNetworkAccess + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}"].get.responses["200"].schema.properties.properties.properties.publicNetworkAccess + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}"].patch.responses["200"].schema.properties.properties.properties.publicNetworkAccess + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers"].get.responses["200"].schema.properties.properties.properties.publicNetworkAccess + - $.paths["/subscriptions/{subscriptionId}/providers/Microsoft.DurableTask/schedulers"].get.responses["200"].schema.properties.properties.properties.publicNetworkAccess + - code: ResourceNameRestriction + reason: The privateLinkResourceName parameter is determined by the Network Resource Provider service and does not require a pattern restriction. + from: + - durabletask.json + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/privateLinkResources/{privateLinkResourceName}"] + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/privateLinkResources/{privateLinkResourceName}"] ``` ### Tag: package-2026-02-01 From 9edc689f5b0cc34a62940f9787b4ecf740e34351 Mon Sep 17 00:00:00 2001 From: Grace Wilcox <43627800+gracewilcox@users.noreply.github.com> Date: Tue, 2 Jun 2026 14:06:31 -0700 Subject: [PATCH 10/22] [Storage Datalake] go updates (#43398) * datalake-go * go datalake * expiresOn * expires on * datalake updates * format * suppressions for batch SDK building * fix suppressions * add missing sub-rules --------- Co-authored-by: Joel Hendrix --- .../datalake-go/client.tsp | 65 +++++++++++++++++++ .../datalake-go/suppressions.yaml | 19 ++++++ .../datalake-go/tspconfig.yaml | 13 ++++ .../Microsoft.BlobStorage/suppressions.yaml | 1 + .../data-plane/DataLakeStorage/client.tsp | 16 +++++ 5 files changed, 114 insertions(+) create mode 100644 specification/storage/Microsoft.BlobStorage/datalake-go/client.tsp create mode 100644 specification/storage/Microsoft.BlobStorage/datalake-go/suppressions.yaml create mode 100644 specification/storage/Microsoft.BlobStorage/datalake-go/tspconfig.yaml diff --git a/specification/storage/Microsoft.BlobStorage/datalake-go/client.tsp b/specification/storage/Microsoft.BlobStorage/datalake-go/client.tsp new file mode 100644 index 000000000000..03bffb7b2c26 --- /dev/null +++ b/specification/storage/Microsoft.BlobStorage/datalake-go/client.tsp @@ -0,0 +1,65 @@ +import "@azure-tools/typespec-client-generator-core"; +import "../main.tsp"; + +using Azure.ClientGenerator.Core; +using Storage.Blob; +using TypeSpec.Http; + +namespace DatalakeGoCustomizations; + +// Root client +@client( + { + name: "ServiceClient", + service: Storage.Blob, + }, + "go" +) +interface ServiceClient { + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Existing API" + listContainersSegment is Service.listContainers; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Existing API" + getUserDelegationKey is Service.getUserDelegationKey; +} +@client( + { + name: "BlobClient", + service: Storage.Blob, + }, + "go" +) +interface BlobClient { + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Existing API" + #suppress "@azure-tools/typespec-azure-core/use-standard-names" "Existing API" + #suppress "@azure-tools/typespec-azure-core/no-response-body" "Existing API" + setExpiry is Blob.setExpiry; +} + +@@alternateType(ExpiryTimeParameter.expiresOn, string, "go"); +@@alternateType(KeyInfo.start, string, "go"); +@@alternateType(KeyInfo.expiry, string, "go"); +@@alternateType(UserDelegationKey.value, string, "go"); +@@clientName(BlobExpiryOptions, "ExpiryOptions", "go"); +@@clientName(ContainerItem, "FileSystemItem", "go"); +@@clientName(ContainerProperties, "FileSystemProperties", "go"); +@@clientName(KeyInfo.delegatedUserTid, "DelegatedUserTenantID", "go"); +@@clientName(LeaseDuration, "LeaseDurationType", "go"); +@@clientName(LeaseState, "LeaseStateType", "go"); +@@clientName(LeaseStatus, "LeaseStatusType", "go"); +@@clientName(ListContainersResponse, "ListFileSystemsSegmentResponse", "go"); +@@clientName(ListContainersResponse.containerItems, "FileSystemItems", "go"); +@@clientName(UserDelegationKey.signedOid, "SignedOID", "go"); +@@clientName(UserDelegationKey.signedTid, "SignedTID", "go"); +@@clientName( + UserDelegationKey.signedDelegatedUserTid, + "SignedDelegatedUserTenantID", + "go" +); +#suppress "@azure-tools/typespec-client-generator-core/client-option" +@@clientOption( + Service.listContainers, + "responseEnvelopeName", + "ServiceClientListFileSystemsSegmentResponse", + "go" +); diff --git a/specification/storage/Microsoft.BlobStorage/datalake-go/suppressions.yaml b/specification/storage/Microsoft.BlobStorage/datalake-go/suppressions.yaml new file mode 100644 index 000000000000..598188a78592 --- /dev/null +++ b/specification/storage/Microsoft.BlobStorage/datalake-go/suppressions.yaml @@ -0,0 +1,19 @@ +- tool: TypeSpecValidation + paths: + - tspconfig.yaml + rules: + - SdkTspConfigValidation + sub-rules: + - options.@azure-tools/typespec-go.generate-fakes + - options.@azure-tools/typespec-go.inject-spans + - options.@azure-tools/typespec-go.service-dir + - options.@azure-tools/typespec-go.package-dir + - options.@azure-tools/typespec-java.emitter-output-dir + - options.@azure-tools/typespec-ts.emitter-output-dir + - options.@azure-tools/typespec-ts.package-details.name + - options.@azure-tools/typespec-python.emitter-output-dir + - options.@azure-tools/typespec-csharp.namespace + - options.@azure-tools/typespec-csharp.clear-output-folder + - options.@azure-tools/typespec-csharp.emitter-output-dir + reason: > + Suppress SDK configuration validation since this directory is only for batch sdk generation. diff --git a/specification/storage/Microsoft.BlobStorage/datalake-go/tspconfig.yaml b/specification/storage/Microsoft.BlobStorage/datalake-go/tspconfig.yaml new file mode 100644 index 000000000000..ec645351fdea --- /dev/null +++ b/specification/storage/Microsoft.BlobStorage/datalake-go/tspconfig.yaml @@ -0,0 +1,13 @@ +parameters: + "service-dir": + default: "sdk/storage" +options: + "@azure-tools/typespec-go": + containing-module: "github.com/Azure/azure-sdk-for-go/sdk/storage/azdatalake" + service-dir: "sdk/storage" + emitter-output-dir: "{output-dir}/{service-dir}/azdatalake/internal/generated_blob" + generate-fakes: false + file-prefix: "zz_" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/data-plane" diff --git a/specification/storage/Microsoft.BlobStorage/suppressions.yaml b/specification/storage/Microsoft.BlobStorage/suppressions.yaml index 34613cb6e95b..ed0561fd9745 100644 --- a/specification/storage/Microsoft.BlobStorage/suppressions.yaml +++ b/specification/storage/Microsoft.BlobStorage/suppressions.yaml @@ -25,3 +25,4 @@ Keeping as fsv1 until migration is over paths: - batch + - datalake-go diff --git a/specification/storage/data-plane/DataLakeStorage/client.tsp b/specification/storage/data-plane/DataLakeStorage/client.tsp index 5716ec04ffa7..04671361c5bf 100644 --- a/specification/storage/data-plane/DataLakeStorage/client.tsp +++ b/specification/storage/data-plane/DataLakeStorage/client.tsp @@ -179,6 +179,9 @@ enum ListBlobsShowOnlyGo { directories: "directories", } @@alternateType(ListBlobsShowOnly, ListBlobsShowOnlyGo, "go"); +@@alternateType(ContentMD5ResponseHeader.contentMD5, string, "go"); +@@alternateType(PathItem.eTag, string, "go"); +@@alternateType(BlobPropertiesInternal.etag, string, "go"); @@clientName(PathItem, "Path", "go"); @@clientName(BlobItem, "PathItemInternal", "go"); @@clientName(BlobHierarchyListSegment.blobItems, "PathItems", "go"); @@ -191,7 +194,13 @@ enum ListBlobsShowOnlyGo { "ListPathsHierarchySegmentResponse", "go" ); +@@clientName( + ListBlobsHierarchySegmentResponse.containerName, + "FileSystemName", + "go" +); @@clientName(BlobHierarchyListSegment, "PathHierarchyListSegment", "go"); +@@clientName(BlobHierarchyListSegment.blobPrefixes, "PathPrefixes", "go"); #suppress "@azure-tools/typespec-client-generator-core/client-option" @@clientOption( FileSystem.listBlobHierarchySegment, @@ -201,3 +210,10 @@ enum ListBlobsShowOnlyGo { ); #suppress "@azure-tools/typespec-client-generator-core/client-option" @@clientOption(PathItem, "omitSerdeMethods", "all", "go"); +#suppress "@azure-tools/typespec-client-generator-core/client-option" +@@clientOption( + FileSystem.listBlobHierarchySegment, + "preserveContentTypeHeader", + true, + "go" +); From 3840abeb616da512eb570d5de958028307b56c85 Mon Sep 17 00:00:00 2001 From: vikeshi26 Date: Tue, 2 Jun 2026 17:35:18 -0400 Subject: [PATCH 11/22] Add trailing newline (#43697) Co-authored-by: Vikeshi Tiwari Co-authored-by: Tejaswi Salaigari --- .../authorization/Microsoft.Authorization/lease.yaml | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .github/arm-leases/authorization/Microsoft.Authorization/lease.yaml diff --git a/.github/arm-leases/authorization/Microsoft.Authorization/lease.yaml b/.github/arm-leases/authorization/Microsoft.Authorization/lease.yaml new file mode 100644 index 000000000000..1d243331e3d6 --- /dev/null +++ b/.github/arm-leases/authorization/Microsoft.Authorization/lease.yaml @@ -0,0 +1,5 @@ +lease: + resource-provider: Microsoft.Authorization + startdate: "2026-05-28" + duration: P180D + reviewer: "@vikeshi26" From f6e21f7af85a89eba3100d4d9137e0c5a93bf49b Mon Sep 17 00:00:00 2001 From: steve munk <33468793+stevemunk@users.noreply.github.com> Date: Tue, 2 Jun 2026 16:57:40 -0500 Subject: [PATCH 12/22] Added impotant note regarding attribution as per TASK 13698157. (#43617) --- specification/maps/data-plane/Render/routes.tsp | 6 ++++++ .../maps/data-plane/Render/stable/2022-08-01/render.json | 2 +- .../maps/data-plane/Render/stable/2024-04-01/render.json | 2 +- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/specification/maps/data-plane/Render/routes.tsp b/specification/maps/data-plane/Render/routes.tsp index a6121e6d6ce3..d95ffc5c4219 100644 --- a/specification/maps/data-plane/Render/routes.tsp +++ b/specification/maps/data-plane/Render/routes.tsp @@ -36,6 +36,12 @@ interface Render { * tile types include Azure Maps road tiles and real-time Weather Radar tiles. By * default, the Azure Maps [Web SDK](/azure/azure-maps/about-azure-maps#web-sdk) * uses vector tiles for rendering its web map control. + * + * > [!Important] + * > + * > When using the **Get Map Tile** API, you must also call the [Get Map Attribution](/rest/api/maps/render/get-map-attribution) API to retrieve the required map data attribution text. + * > + * > The returned attribution must be displayed wherever tiles retrieved from **Get Map Tile** are rendered, including in third-party map controls or custom rendering implementations. */ #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Non-standard operation." @summary("Use to request map tiles in vector or raster format.") diff --git a/specification/maps/data-plane/Render/stable/2022-08-01/render.json b/specification/maps/data-plane/Render/stable/2022-08-01/render.json index ca40d33419b4..b482fe742ab1 100644 --- a/specification/maps/data-plane/Render/stable/2022-08-01/render.json +++ b/specification/maps/data-plane/Render/stable/2022-08-01/render.json @@ -273,7 +273,7 @@ "/map/tile": { "get": { "summary": "Use to request map tiles in vector or raster format.", - "description": "**\n\nThe `Get Map Tiles` API enables users to request map tiles in either vector or raster formats, typically for integration into a map control or SDK. Supported tile types include Azure Maps road tiles and real-time Weather Radar tiles. By default, the Azure Maps [Web SDK](/azure/azure-maps/about-azure-maps#web-sdk) uses vector tiles for rendering its web map control.", + "description": "**\n\nThe `Get Map Tiles` API enables users to request map tiles in either vector or raster formats, typically for integration into a map control or SDK. Supported tile types include Azure Maps road tiles and real-time Weather Radar tiles. By default, the Azure Maps [Web SDK](/azure/azure-maps/about-azure-maps#web-sdk) uses vector tiles for rendering its web map control.\n\n> [!Important]\n>\n> When using the **Get Map Tile** API, you must also call the [Get Map Attribution](/rest/api/maps/render/get-map-attribution) API to retrieve the required map data attribution text.\n>\n> The returned attribution must be displayed wherever tiles retrieved from **Get Map Tile** are rendered, including in third-party map controls or custom rendering implementations.", "operationId": "Render_GetMapTile", "x-ms-client-name": "GetMapTile", "x-ms-examples": { 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 index d8c5dfe07d3f..480bd75415ad 100644 --- a/specification/maps/data-plane/Render/stable/2024-04-01/render.json +++ b/specification/maps/data-plane/Render/stable/2024-04-01/render.json @@ -1102,7 +1102,7 @@ "get": { "operationId": "Render_GetMapTile", "summary": "Use to request map tiles in vector or raster format.", - "description": "The `Get Map Tiles` API enables users to request map tiles in either vector or\nraster formats, typically for integration into a map control or SDK. Supported\ntile types include Azure Maps road tiles and real-time Weather Radar tiles. By\ndefault, the Azure Maps [Web SDK](/azure/azure-maps/about-azure-maps#web-sdk)\nuses vector tiles for rendering its web map control.", + "description": "The `Get Map Tiles` API enables users to request map tiles in either vector or\nraster formats, typically for integration into a map control or SDK. Supported\ntile types include Azure Maps road tiles and real-time Weather Radar tiles. By\ndefault, the Azure Maps [Web SDK](/azure/azure-maps/about-azure-maps#web-sdk)\nuses vector tiles for rendering its web map control.\n\n> [!Important]\n>\n> When using the **Get Map Tile** API, you must also call the [Get Map Attribution](/rest/api/maps/render/get-map-attribution) API to retrieve the required map data attribution text.\n>\n> The returned attribution must be displayed wherever tiles retrieved from **Get Map Tile** are rendered, including in third-party map controls or custom rendering implementations.", "produces": [ "application/json", "image/jpeg", From 1df63ddd2e21a96cc156cdb2d6133171be3315e1 Mon Sep 17 00:00:00 2001 From: "azure-sdk-automation[bot]" <191533747+azure-sdk-automation[bot]@users.noreply.github.com> Date: Tue, 2 Jun 2026 15:45:53 -0700 Subject: [PATCH 13/22] Update fetching of installation ID (#43699) Co-authored-by: Chidozie Ononiwu --- .../templates/steps/create-tags-and-git-release.yml | 2 +- eng/common/scripts/login-to-github.ps1 | 10 ++++++---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/eng/common/pipelines/templates/steps/create-tags-and-git-release.yml b/eng/common/pipelines/templates/steps/create-tags-and-git-release.yml index 35df366c2322..b81e72ac9b7f 100644 --- a/eng/common/pipelines/templates/steps/create-tags-and-git-release.yml +++ b/eng/common/pipelines/templates/steps/create-tags-and-git-release.yml @@ -15,7 +15,7 @@ steps: - template: /eng/common/pipelines/templates/steps/login-to-github.yml parameters: TokenOwners: - - ${{ split(parameters.RepoId, '/')[0] }} + - ${{ parameters.RepoId }} ScriptDirectory: ${{ parameters.ScriptDirectory }} - task: PowerShell@2 diff --git a/eng/common/scripts/login-to-github.ps1 b/eng/common/scripts/login-to-github.ps1 index 129946a409b3..736d62bc96ac 100644 --- a/eng/common/scripts/login-to-github.ps1 +++ b/eng/common/scripts/login-to-github.ps1 @@ -131,7 +131,7 @@ function Get-GitHubInstallationId { $resp | Foreach-Object { Write-Host " $($_.id): $($_.account.login) [$($_.target_type)]" } $resp = $resp | Where-Object { $_.account.login -ieq $InstallationTokenOwner } - if (!$resp.id) { throw "No installations found for this App." } + if ($null -eq $resp -or !$resp.id) { throw "No installation found for '$InstallationTokenOwner' in this App. Verify the App is installed on that org/user." } return $resp.id } @@ -154,8 +154,10 @@ $jwt = New-GitHubAppJwt -VaultName $KeyVaultName -KeyName $KeyName -AppId $GitHu foreach ($InstallationTokenOwner in $InstallationTokenOwners) { - Write-Host "Fetching installation ID for $InstallationTokenOwner ..." - $installationId = Get-GitHubInstallationId -Jwt $jwt -ApiBase $GitHubApiBaseUrl -ApiVersion $GitHubApiVersion -InstallationTokenOwner $InstallationTokenOwner + # Token owners can be provided as either "owner" or "owner/repo". Normalize to owner. + $normalizedOwner = ($InstallationTokenOwner -split '/')[0] + Write-Host "Fetching installation ID for $InstallationTokenOwner (normalized owner: $normalizedOwner) ..." + $installationId = Get-GitHubInstallationId -Jwt $jwt -ApiBase $GitHubApiBaseUrl -ApiVersion $GitHubApiVersion -InstallationTokenOwner $normalizedOwner Write-Host "Installation ID resolved: $installationId" @@ -165,7 +167,7 @@ foreach ($InstallationTokenOwner in $InstallationTokenOwners) $variableName = $VariableNamePrefix if ($InstallationTokenOwners.Count -gt 1) { - $variableName = $VariableNamePrefix + "_" + $InstallationTokenOwner + $variableName = $VariableNamePrefix + "_" + $normalizedOwner } Set-Item -Path Env:$variableName -Value $installationToken From 532545feb236d55064e4fa922f3fa38517857ba8 Mon Sep 17 00:00:00 2001 From: efrainretana <141282336+efrainretana@users.noreply.github.com> Date: Tue, 2 Jun 2026 18:38:38 -0500 Subject: [PATCH 14/22] [Search] Add API version to tspconfig (#43695) * [Search] Add API version to tspconfig * Add small comment --- specification/search/data-plane/Search/tspconfig.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/search/data-plane/Search/tspconfig.yaml b/specification/search/data-plane/Search/tspconfig.yaml index df24a321c27c..08a0703b31ef 100644 --- a/specification/search/data-plane/Search/tspconfig.yaml +++ b/specification/search/data-plane/Search/tspconfig.yaml @@ -16,6 +16,7 @@ options: namespace: "Azure.Search.Documents" model-namespace: true emitter-output-dir: "{output-dir}/{service-dir}/Azure.Search.Documents" + api-version: "2026-04-01" # TODO: Remove api version pin when 2026-04-01 bugs are addressed in .NET SDK. "@azure-tools/typespec-ts": emitter-output-dir: "{output-dir}/{service-dir}/search-documents" generate-metadata: false From 0c30072709ed8a6a544ec133e628e13cb3c81d88 Mon Sep 17 00:00:00 2001 From: Weidong Xu Date: Wed, 3 Jun 2026 13:44:41 +0800 Subject: [PATCH 15/22] Fix Java hostname client name for ManagedNetworkFabric (#43703) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../client.tsp | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/client.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/client.tsp index 919bc40ec71a..98303f45693e 100644 --- a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/client.tsp +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/client.tsp @@ -81,3 +81,14 @@ using Microsoft.ManagedNetworkFabric; "peerAsn", "java" ); + +@@clientName( + Microsoft.ManagedNetworkFabric.NetworkDeviceProperties.hostName, + "hostname", + "java" +); +@@clientName( + Microsoft.ManagedNetworkFabric.NetworkDevicePatchableProperties.hostName, + "hostname", + "java" +); From 3b6931791059d206fa05e2244475ed88799c615d Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Wed, 3 Jun 2026 15:28:07 +0800 Subject: [PATCH 16/22] Update client.tsp (#43709) --- .../resource-manager/Microsoft.DevHub/DeveloperHub/client.tsp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/developerhub/resource-manager/Microsoft.DevHub/DeveloperHub/client.tsp b/specification/developerhub/resource-manager/Microsoft.DevHub/DeveloperHub/client.tsp index b0b740a3f98b..f6ddf1b1b033 100644 --- a/specification/developerhub/resource-manager/Microsoft.DevHub/DeveloperHub/client.tsp +++ b/specification/developerhub/resource-manager/Microsoft.DevHub/DeveloperHub/client.tsp @@ -12,7 +12,7 @@ using Microsoft.DevHub; @@clientName(Microsoft.DevHub, "DeveloperHubServiceClient", "javascript,java"); @@clientName(Microsoft.DevHub, "DevHubMgmtClient", "python"); @@clientName(ACR, "Acr", "java,javascript"); -@@clientName(Deployment, "DeploymentProperties", "java,javascript"); +@@clientName(Deployment, "DeploymentProperties", "java,javascript,python"); // consistency on "AdoOAuth" @@clientName(AdooAuthResponse, "AdoOAuthResponse", "java"); @@clientName(AdooAuthResponses, "AdoOAuthResponses", "java"); From d76af257e62661032da4df722d67268334371c82 Mon Sep 17 00:00:00 2001 From: Yuchao Yan Date: Wed, 3 Jun 2026 15:32:38 +0800 Subject: [PATCH 17/22] Mitigate Python SDK breaking changes for azure-mgmt-hdinsight (#43705) --- .../resource-manager/Microsoft.HDInsight/HDInsight/client.tsp | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsight/client.tsp b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsight/client.tsp index ab0a191f76a6..6d7558ffc1d2 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsight/client.tsp +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsight/client.tsp @@ -10,7 +10,6 @@ using Azure.ClientGenerator.Core; "javascript,python" ); -@@clientName(ErrorResponse, "ErrorResponseAutoGenerated", "python"); @@clientName(JsonWebKeyEncryptionAlgorithm.`RSA-OAEP`, "RSA_OAEP", "python"); @@clientName( JsonWebKeyEncryptionAlgorithm.`RSA-OAEP-256`, From ecd420c9534d0dab69be38027c1723031504b081 Mon Sep 17 00:00:00 2001 From: Yuchao Yan Date: Wed, 3 Jun 2026 15:33:31 +0800 Subject: [PATCH 18/22] Mitigate Python SDK breaking changes for azure-mgmt-healthcareapis (#43704) --- .../Microsoft.HealthcareApis/HealthcareApis/client.tsp | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/HealthcareApis/client.tsp b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/HealthcareApis/client.tsp index 05fb49d14675..92a523e9ea08 100644 --- a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/HealthcareApis/client.tsp +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/HealthcareApis/client.tsp @@ -16,15 +16,10 @@ namespace Microsoft.HealthcareApis; @@clientLocation(FhirServiceOperationGroup.update, FhirServices, "python"); @@clientLocation(IotConnectorOperationGroup.delete, IotConnectors, "python"); @@clientLocation(IotConnectorOperationGroup.update, IotConnectors, "python"); -@@clientName( - ManagedServiceIdentityType, - "ManagedServiceIdentityTypeAutoGenerated", - "python" -); @@clientName( Azure.ResourceManager.CommonTypes.ManagedServiceIdentityType, "ArmManagedServiceIdentityType", - "javascript,go,java" + "python,javascript,go,java" ); #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Mitigate Java breaking change from Swagger to TypeSpec" @@Legacy.flattenProperty( From f2b3df51e564c690ebcd33735fc9e819b3b617f8 Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Wed, 3 Jun 2026 16:11:38 +0800 Subject: [PATCH 19/22] [Python] Mitigate breaking changes for azure-mgmt-managednetworkfabric (#43710) * Mitigate Python SDK breaking changes for azure-mgmt-managednetworkfabric * Update client.tsp --- .../client.tsp | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/client.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/client.tsp index 98303f45693e..adfb2f56ccf9 100644 --- a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/client.tsp +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/client.tsp @@ -92,3 +92,24 @@ using Microsoft.ManagedNetworkFabric; "hostname", "java" ); + +@@clientName( + Microsoft.ManagedNetworkFabric, + "ManagedNetworkFabricMgmtClient", + "python" +); +@@clientName( + Microsoft.ManagedNetworkFabric.ManagementNetworkPatchConfiguration, + "ManagementNetworkConfigurationPatchableProperties", + "python" +); +@@clientName( + Microsoft.ManagedNetworkFabric.TerminalServerPatchConfiguration, + "NetworkFabricPatchablePropertiesTerminalServerConfiguration", + "python" +); +@@clientName( + Microsoft.ManagedNetworkFabric.VpnOptionBProperties, + "OptionBProperties", + "python" +); From ebf2267d5d84642e2b542fa83aac3607d26dcde9 Mon Sep 17 00:00:00 2001 From: "Jiao Di (MSFT)" <80496810+v-jiaodi@users.noreply.github.com> Date: Wed, 3 Jun 2026 16:14:43 +0800 Subject: [PATCH 20/22] [JS] Mitigate breaking change for refresh SDK (#43707) * update config * update * update * update --- .../Microsoft.Advisor/Advisor/tspconfig.yaml | 1 + .../dynatrace/Dynatrace.Management/tspconfig.yaml | 3 +++ .../Microsoft.StorageSync/StorageSync/back-compatible.tsp | 7 ++++++- .../Microsoft.StorageSync/StorageSync/client.tsp | 2 +- .../Microsoft.StorageSync/StorageSync/tspconfig.yaml | 1 + .../Microsoft.SignalRService/SignalRService/tspconfig.yaml | 1 + 6 files changed, 13 insertions(+), 2 deletions(-) diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/Advisor/tspconfig.yaml b/specification/advisor/resource-manager/Microsoft.Advisor/Advisor/tspconfig.yaml index cf6faa631621..20a9c58411ef 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/Advisor/tspconfig.yaml +++ b/specification/advisor/resource-manager/Microsoft.Advisor/Advisor/tspconfig.yaml @@ -25,6 +25,7 @@ options: "@azure-tools/typespec-ts": emitter-output-dir: "{output-dir}/{service-dir}/arm-advisor" flavor: azure + treat-unknown-as-record: true experimental-extensible-enums: true package-details: name: "@azure/arm-advisor" diff --git a/specification/dynatrace/Dynatrace.Management/tspconfig.yaml b/specification/dynatrace/Dynatrace.Management/tspconfig.yaml index e4cbbec24cbb..2f0135947720 100644 --- a/specification/dynatrace/Dynatrace.Management/tspconfig.yaml +++ b/specification/dynatrace/Dynatrace.Management/tspconfig.yaml @@ -30,6 +30,9 @@ options: emitter-output-dir: "{output-dir}/{service-dir}/arm-dynatrace" package-dir: "arm-dynatrace" flavor: "azure" + compatibility-lro: true + typespec-title-map: + ObservabilityClient: "DynatraceObservability" experimental-extensible-enums: true package-details: name: "@azure/arm-dynatrace" diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/StorageSync/back-compatible.tsp b/specification/storagesync/resource-manager/Microsoft.StorageSync/StorageSync/back-compatible.tsp index 1342e4c4d79d..96495494b663 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/StorageSync/back-compatible.tsp +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/StorageSync/back-compatible.tsp @@ -126,7 +126,12 @@ using Microsoft.StorageSync; @@clientLocation( OperationStatusOperationGroup.get, "OperationStatus", - "!csharp" + "!csharp,!javascript" +); +@@clientLocation( + OperationStatusOperationGroup.get, + "OperationStatusOperations", + "javascript" ); @@clientLocation( StorageSyncServices.listByStorageSyncService, diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/StorageSync/client.tsp b/specification/storagesync/resource-manager/Microsoft.StorageSync/StorageSync/client.tsp index 7f5f9455202b..d76f0515057a 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/StorageSync/client.tsp +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/StorageSync/client.tsp @@ -12,7 +12,7 @@ using Microsoft.StorageSync; #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" @@Azure.ClientGenerator.Core.Legacy.flattenProperty( Azure.ResourceManager.CommonTypes.PrivateLinkResource.properties, - "csharp" + "csharp,javascript" ); @@clientName(RestoreFileSpec.isdir, "IsDirectory", "csharp"); diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/StorageSync/tspconfig.yaml b/specification/storagesync/resource-manager/Microsoft.StorageSync/StorageSync/tspconfig.yaml index d1fa0fade7f5..fd5f9072efdc 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/StorageSync/tspconfig.yaml +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/StorageSync/tspconfig.yaml @@ -28,6 +28,7 @@ options: flavor: azure typespec-title-map: StorageSyncClient: "MicrosoftStorageSync" + compatibility-lro: true experimental-extensible-enums: true package-details: name: "@azure/arm-storagesync" diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/SignalRService/tspconfig.yaml b/specification/webpubsub/resource-manager/Microsoft.SignalRService/SignalRService/tspconfig.yaml index 1fbd8ebf94b0..caae399df4ef 100644 --- a/specification/webpubsub/resource-manager/Microsoft.SignalRService/SignalRService/tspconfig.yaml +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/SignalRService/tspconfig.yaml @@ -27,6 +27,7 @@ options: service-dir: "sdk/web-pubsub" flavor: azure experimental-extensible-enums: true + compatibility-lro: true package-details: name: "@azure/arm-webpubsub" "@azure-typespec/http-client-csharp-mgmt": From 5fd1b49f198cf1e343a35921459de050ae829139 Mon Sep 17 00:00:00 2001 From: Wei Hu Date: Wed, 3 Jun 2026 16:52:39 +0800 Subject: [PATCH 21/22] Fix ComputeBulkActions C# SDK customizations (#43683) --- .../ComputeBulkActions.Management/client.tsp | 535 +++++++++++++++++- 1 file changed, 505 insertions(+), 30 deletions(-) diff --git a/specification/computebulkactions/ComputeBulkActions.Management/client.tsp b/specification/computebulkactions/ComputeBulkActions.Management/client.tsp index a04c57ae7e3f..fe54385ebea5 100644 --- a/specification/computebulkactions/ComputeBulkActions.Management/client.tsp +++ b/specification/computebulkactions/ComputeBulkActions.Management/client.tsp @@ -2,6 +2,7 @@ import "@azure-tools/typespec-client-generator-core"; import "./main.tsp"; using Azure.ClientGenerator.Core; +using Azure.Core; namespace Microsoft.ComputeBulkActions; @@ -30,43 +31,67 @@ namespace Microsoft.ComputeBulkActions; // ===================================================================== // Critical: Request suffix → Content suffix // ===================================================================== -@@clientName(CancelOperationsRequest, "CancelOperationsContent", "csharp"); +@@clientName( + CancelOperationsRequest, + "BulkActionCancelOperationsContent", + "csharp" +); @@clientName(ExecuteTypeRequest, "ExecuteTypeContent", "csharp"); -@@clientName(ExecuteCreateRequest, "ExecuteCreateContent", "csharp"); -@@clientName(ExecuteDeallocateRequest, "ExecuteDeallocateContent", "csharp"); -@@clientName(ExecuteDeleteRequest, "ExecuteDeleteContent", "csharp"); -@@clientName(ExecuteHibernateRequest, "ExecuteHibernateContent", "csharp"); -@@clientName(ExecuteStartRequest, "ExecuteStartContent", "csharp"); -@@clientName(GetOperationStatusRequest, "GetOperationStatusContent", "csharp"); +@@clientName(ExecuteCreateRequest, "BulkActionExecuteCreateContent", "csharp"); +@@clientName( + ExecuteDeallocateRequest, + "BulkActionExecuteDeallocateContent", + "csharp" +); +@@clientName(ExecuteDeleteRequest, "BulkActionExecuteDeleteContent", "csharp"); +@@clientName( + ExecuteHibernateRequest, + "BulkActionExecuteHibernateContent", + "csharp" +); +@@clientName(ExecuteStartRequest, "BulkActionExecuteStartContent", "csharp"); +@@clientName( + GetOperationStatusRequest, + "BulkActionGetOperationStatusContent", + "csharp" +); // ===================================================================== // Critical: Response suffix → Result suffix // ===================================================================== -@@clientName(CancelOperationsResponse, "CancelOperationsResult", "csharp"); +@@clientName( + CancelOperationsResponse, + "BulkActionCancelOperationsResult", + "csharp" +); @@clientName( CreateResourceOperationResponse, - "CreateResourceOperationResult", + "BulkActionCreateResourceOperationResult", "csharp" ); @@clientName( DeallocateResourceOperationResponse, - "DeallocateResourceOperationResult", + "BulkActionDeallocateResourceOperationResult", "csharp" ); @@clientName( DeleteResourceOperationResponse, - "DeleteResourceOperationResult", + "BulkActionDeleteResourceOperationResult", + "csharp" +); +@@clientName( + GetOperationStatusResponse, + "BulkActionGetOperationStatusResult", "csharp" ); -@@clientName(GetOperationStatusResponse, "GetOperationStatusResult", "csharp"); @@clientName( HibernateResourceOperationResponse, - "HibernateResourceOperationResult", + "BulkActionHibernateResourceOperationResult", "csharp" ); @@clientName( StartResourceOperationResponse, - "StartResourceOperationResult", + "BulkActionStartResourceOperationResult", "csharp" ); @@ -74,35 +99,451 @@ namespace Microsoft.ComputeBulkActions; // Critical: Parameters suffix // ===================================================================== @@clientName(ExecutionParameters, "BulkActionExecutionConfig", "csharp"); +@@clientName( + ManagedDiskParameters, + "ComputeBulkActionsManagedDiskInfo", + "csharp" +); +@@clientName( + DiskEncryptionSetParameters, + "ComputeBulkActionsDiskEncryptionSetReference", + "csharp" +); // ===================================================================== // Warning: Plural enum names → singular // ===================================================================== -@@clientName(CachingTypes, "CachingType", "csharp"); -@@clientName(DiskControllerTypes, "DiskControllerType", "csharp"); -@@clientName(DiskCreateOptionTypes, "DiskCreateOptionType", "csharp"); -@@clientName(DiskDeleteOptionTypes, "DiskDeleteOptionType", "csharp"); -@@clientName(DiskDetachOptionTypes, "DiskDetachOptionType", "csharp"); -@@clientName(DomainNameLabelScopeTypes, "DomainNameLabelScopeType", "csharp"); -@@clientName(IPVersions, "IPVersion", "csharp"); -@@clientName(OperatingSystemTypes, "OperatingSystemType", "csharp"); -@@clientName(ProtocolTypes, "ProtocolType", "csharp"); -@@clientName(SecurityEncryptionTypes, "SecurityEncryptionType", "csharp"); -@@clientName(SecurityTypes, "SecurityType", "csharp"); -@@clientName(SettingNames, "SettingName", "csharp"); -@@clientName(StorageAccountTypes, "StorageAccountType", "csharp"); +@@clientName(CachingTypes, "ComputeBulkActionsCachingType", "csharp"); +@@clientName( + DiskControllerTypes, + "ComputeBulkActionsDiskControllerType", + "csharp" +); +@@clientName( + DiskCreateOptionTypes, + "ComputeBulkActionsDiskCreateOptionType", + "csharp" +); +@@clientName( + DiskDeleteOptionTypes, + "ComputeBulkActionsDiskDeleteOptionType", + "csharp" +); +@@clientName( + DiskDetachOptionTypes, + "ComputeBulkActionsDiskDetachOptionType", + "csharp" +); +@@clientName( + DomainNameLabelScopeTypes, + "ComputeBulkActionsDomainNameLabelScopeType", + "csharp" +); +@@clientName(IPVersions, "ComputeBulkActionsIPVersion", "csharp"); +@@clientName( + OperatingSystemTypes, + "ComputeBulkActionsOperatingSystemType", + "csharp" +); +@@clientName(ProtocolTypes, "ComputeBulkActionsProtocolType", "csharp"); +@@clientName( + SecurityEncryptionTypes, + "ComputeBulkActionsSecurityEncryptionType", + "csharp" +); +@@clientName(SecurityTypes, "ComputeBulkActionsSecurityType", "csharp"); +@@clientName( + SettingNames, + "ComputeBulkActionsAdditionalUnattendContentSettingName", + "csharp" +); +@@clientName( + StorageAccountTypes, + "ComputeBulkActionsStorageAccountType", + "csharp" +); +@@clientName(DeleteOptions, "ComputeBulkActionsDeleteOption", "csharp"); +@@clientName(DiffDiskOptions, "ComputeBulkActionsDiffDiskOption", "csharp"); + +// ===================================================================== +// Warning: Acronym casing +// ===================================================================== +@@clientName(AcceleratorType.GPU, "Gpu", "csharp"); +@@clientName(AcceleratorType.FPGA, "Fpga", "csharp"); +@@clientName(LocalStorageDiskType.HDD, "Hdd", "csharp"); +@@clientName(LocalStorageDiskType.SSD, "Ssd", "csharp"); + +// ===================================================================== +// Warning: ARM resource identifier types +// ===================================================================== +@@alternateType(ApiEntityReference.id, armResourceIdentifier, "csharp"); +@@alternateType(SubResource.id, armResourceIdentifier, "csharp"); +@@alternateType( + VMGalleryApplication.packageReferenceId, + armResourceIdentifier, + "csharp" +); +@@alternateType( + EncryptionIdentity.userAssignedIdentityResourceId, + armResourceIdentifier, + "csharp" +); +@@alternateType( + HostEndpointSettings.inVMAccessControlProfileReferenceId, + armResourceIdentifier, + "csharp" +); // ===================================================================== // Warning: Ambiguous type names // ===================================================================== -@@clientName(Mode, "ProxyAgentMode", "csharp"); -@@clientName(Modes, "HostEndpointMode", "csharp"); +@@clientName(LocationBasedLaunchBulkInstancesOperation, "BulkAction", "csharp"); +@@clientName(Mode, "ComputeBulkActionsProxyAgentMode", "csharp"); +@@clientName(Modes, "ComputeBulkActionsHostEndpointMode", "csharp"); @@clientName(ApiError, "ComputeBulkActionsApiError", "csharp"); +@@clientName(ApiError.innererror, "InnerError", "csharp"); @@clientName(ApiErrorBase, "ComputeBulkActionsApiErrorBase", "csharp"); @@clientName(InnerError, "ComputeBulkActionsInnerError", "csharp"); @@clientName(SubResource, "ComputeBulkActionsSubResource", "csharp"); @@clientName(RetryPolicy, "BulkActionRetryPolicy", "csharp"); -@@clientName(ResourceOperation, "BulkActionResourceOperation", "csharp"); +@@clientName(ResourceOperation, "BulkActionResourceOperationInfo", "csharp"); +@@clientName(VirtualMachine, "BulkActionVirtualMachineResult", "csharp"); +@@clientName( + AdditionalCapabilities, + "ComputeBulkActionsAdditionalCapabilities", + "csharp" +); +@@clientName(BootDiagnostics, "ComputeBulkActionsBootDiagnostics", "csharp"); +@@clientName(DataDisk, "ComputeBulkActionsDataDisk", "csharp"); +@@clientName(ImageReference, "ComputeBulkActionsImageReference", "csharp"); +@@clientName(NetworkProfile, "ComputeBulkActionsNetworkProfile", "csharp"); +@@clientName(OSDisk, "ComputeBulkActionsOSDisk", "csharp"); +@@clientName(OSProfile, "ComputeBulkActionsOSProfile", "csharp"); +@@clientName(PatchSettings, "ComputeBulkActionsPatchSettings", "csharp"); +@@clientName(SecurityProfile, "ComputeBulkActionsSecurityProfile", "csharp"); +@@clientName(StorageProfile, "ComputeBulkActionsStorageProfile", "csharp"); +@@clientName(ProvisioningState, "BulkActionProvisioningState", "csharp"); +@@clientName(OperationState, "BulkActionOperationState", "csharp"); +@@clientName( + AllocationStrategy, + "ComputeBulkActionsAllocationStrategy", + "csharp" +); +@@clientName(CapacityType, "ComputeBulkActionsCapacityType", "csharp"); +@@clientName(DeadlineType, "ComputeBulkActionsDeadlineType", "csharp"); +@@clientName(EvictionPolicy, "ComputeBulkActionsEvictionPolicy", "csharp"); +@@clientName( + OptimizationPreference, + "ComputeBulkActionsOptimizationPreference", + "csharp" +); +@@clientName( + VirtualMachineType, + "ComputeBulkActionsVirtualMachineType", + "csharp" +); +@@clientName( + VirtualMachineProfile, + "ComputeBulkActionsVirtualMachineProfile", + "csharp" +); +@@clientName( + VirtualMachineExtension, + "ComputeBulkActionsVirtualMachineExtension", + "csharp" +); +@@clientName( + VirtualMachineExtensionProperties, + "ComputeBulkActionsVirtualMachineExtensionProperties", + "csharp" +); +@@clientName( + LinuxConfiguration, + "ComputeBulkActionsLinuxConfiguration", + "csharp" +); +@@clientName( + WindowsConfiguration, + "ComputeBulkActionsWindowsConfiguration", + "csharp" +); +@@clientName(SshPublicKey, "ComputeBulkActionsSshPublicKey", "csharp"); +@@clientName( + NetworkApiVersion, + "ComputeBulkActionsNetworkApiVersion", + "csharp" +); +@@clientName( + NetworkInterfaceReference, + "ComputeBulkActionsNetworkInterfaceReference", + "csharp" +); +@@clientName(PriorityProfile, "ComputeBulkActionsPriorityProfile", "csharp"); +@@clientName(ZonePreference, "ComputeBulkActionsZonePreference", "csharp"); +@@clientName( + ResourceOperationDetails, + "BulkActionResourceOperationDetails", + "csharp" +); +@@clientName( + ResourceOperationError, + "BulkActionResourceOperationError", + "csharp" +); +@@clientName( + ResourceOperationType, + "BulkActionResourceOperationType", + "csharp" +); +@@clientName( + ResourceProvisionPayload, + "BulkActionResourceProvisionPayload", + "csharp" +); +@@clientName(VMOperationStatus, "BulkActionVMOperationStatus", "csharp"); +@@clientName( + AcceleratorManufacturer, + "ComputeBulkActionsAcceleratorManufacturer", + "csharp" +); +@@clientName(AcceleratorType, "ComputeBulkActionsAcceleratorType", "csharp"); +@@clientName(ArchitectureType, "ComputeBulkActionsArchitectureType", "csharp"); +@@clientName(CpuManufacturer, "ComputeBulkActionsCpuManufacturer", "csharp"); +@@clientName(ComputeProfile, "BulkActionComputeProfile", "csharp"); +@@clientName( + HostEndpointSettings, + "ComputeBulkActionsHostEndpointSettings", + "csharp" +); +@@clientName( + ProxyAgentSettings, + "ComputeBulkActionsProxyAgentSettings", + "csharp" +); +@@clientName( + DiskEncryptionSettings, + "ComputeBulkActionsDiskEncryptionSettings", + "csharp" +); +@@clientName( + KeyVaultKeyReference, + "ComputeBulkActionsKeyVaultKeyReference", + "csharp" +); +@@clientName( + KeyVaultSecretReference, + "ComputeBulkActionsKeyVaultSecretReference", + "csharp" +); +@@clientName( + PublicIPAddressSku, + "ComputeBulkActionsPublicIPAddressSku", + "csharp" +); +@@clientName( + PublicIPAddressSkuName, + "ComputeBulkActionsPublicIPAddressSkuName", + "csharp" +); +@@clientName( + PublicIPAddressSkuTier, + "ComputeBulkActionsPublicIPAddressSkuTier", + "csharp" +); +@@clientName( + PublicIPAllocationMethod, + "ComputeBulkActionsPublicIPAllocationMethod", + "csharp" +); +@@clientName( + NetworkInterfaceAuxiliaryMode, + "ComputeBulkActionsNetworkInterfaceAuxiliaryMode", + "csharp" +); +@@clientName( + NetworkInterfaceAuxiliarySku, + "ComputeBulkActionsNetworkInterfaceAuxiliarySku", + "csharp" +); +@@clientName( + NetworkInterfaceReferenceProperties, + "ComputeBulkActionsNetworkInterfaceReferenceProperties", + "csharp" +); +@@clientName( + ScheduledEventsPolicy, + "ComputeBulkActionsScheduledEventsPolicy", + "csharp" +); +@@clientName( + ScheduledEventsProfile, + "ComputeBulkActionsScheduledEventsProfile", + "csharp" +); +@@clientName( + TerminateNotificationProfile, + "ComputeBulkActionsTerminateNotificationProfile", + "csharp" +); +@@clientName(VaultCertificate, "ComputeBulkActionsVaultCertificate", "csharp"); +@@clientName(VaultSecretGroup, "ComputeBulkActionsVaultSecretGroup", "csharp"); +@@clientName(VMCategory, "ComputeBulkActionsVMCategory", "csharp"); +@@clientName( + ZoneAllocationPolicy, + "ComputeBulkActionsZoneAllocationPolicy", + "csharp" +); +@@clientName( + ZoneDistributionStrategy, + "ComputeBulkActionsZoneDistributionStrategy", + "csharp" +); +@@clientName( + AdditionalUnattendContent, + "ComputeBulkActionsAdditionalUnattendContent", + "csharp" +); +@@clientName( + DiffDiskPlacement, + "ComputeBulkActionsDiffDiskPlacement", + "csharp" +); +@@clientName(DiffDiskSettings, "ComputeBulkActionsDiffDiskSettings", "csharp"); +@@clientName( + EventGridAndResourceGraph, + "ComputeBulkActionsEventGridAndResourceGraph", + "csharp" +); +@@clientName(HyperVGeneration, "ComputeBulkActionsHyperVGeneration", "csharp"); +@@clientName( + LaunchBulkInstancesOperationProperties, + "ComputeBulkActionsLaunchBulkInstancesOperationProperties", + "csharp" +); +@@clientName( + LinuxPatchAssessmentMode, + "ComputeBulkActionsLinuxPatchAssessmentMode", + "csharp" +); +@@clientName( + LinuxPatchSettings, + "ComputeBulkActionsLinuxPatchSettings", + "csharp" +); +@@clientName( + LinuxVMGuestPatchAutomaticByPlatformRebootSetting, + "ComputeBulkActionsLinuxVMGuestPatchAutomaticByPlatformRebootSetting", + "csharp" +); +@@clientName( + LinuxVMGuestPatchAutomaticByPlatformSettings, + "ComputeBulkActionsLinuxVMGuestPatchAutomaticByPlatformSettings", + "csharp" +); +@@clientName( + LinuxVMGuestPatchMode, + "ComputeBulkActionsLinuxVMGuestPatchMode", + "csharp" +); +@@clientName( + LocalStorageDiskType, + "ComputeBulkActionsLocalStorageDiskType", + "csharp" +); +@@clientName( + OSImageNotificationProfile, + "ComputeBulkActionsOSImageNotificationProfile", + "csharp" +); +@@clientName(UefiSettings, "ComputeBulkActionsUefiSettings", "csharp"); +@@clientName( + VirtualMachineIpTag, + "ComputeBulkActionsVirtualMachineIpTag", + "csharp" +); +@@clientName( + VirtualMachineNetworkInterfaceConfiguration, + "ComputeBulkActionsVirtualMachineNetworkInterfaceConfiguration", + "csharp" +); +@@clientName( + VirtualMachineNetworkInterfaceConfigurationProperties, + "ComputeBulkActionsVirtualMachineNetworkInterfaceConfigurationProperties", + "csharp" +); +@@clientName( + VirtualMachineNetworkInterfaceIPConfiguration, + "ComputeBulkActionsVirtualMachineNetworkInterfaceIPConfiguration", + "csharp" +); +@@clientName( + VirtualMachineNetworkInterfaceIPConfigurationProperties, + "ComputeBulkActionsVirtualMachineNetworkInterfaceIPConfigurationProperties", + "csharp" +); +@@clientName( + VirtualMachinePublicIPAddressConfiguration, + "ComputeBulkActionsVirtualMachinePublicIPAddressConfiguration", + "csharp" +); +@@clientName( + VirtualMachinePublicIPAddressConfigurationProperties, + "ComputeBulkActionsVirtualMachinePublicIPAddressConfigurationProperties", + "csharp" +); +@@clientName( + VirtualMachinePublicIPAddressDnsSettingsConfiguration, + "ComputeBulkActionsVirtualMachinePublicIPAddressDnsSettingsConfiguration", + "csharp" +); +@@clientName( + VMAttributeMinMaxDouble, + "ComputeBulkActionsVMAttributeMinMaxDouble", + "csharp" +); +@@clientName( + VMAttributeMinMaxInteger, + "ComputeBulkActionsVMAttributeMinMaxInteger", + "csharp" +); +@@clientName(VMAttributes, "ComputeBulkActionsVMAttributes", "csharp"); +@@clientName( + VMAttributeSupport, + "ComputeBulkActionsVMAttributeSupport", + "csharp" +); +@@clientName( + VMDiskSecurityProfile, + "ComputeBulkActionsVMDiskSecurityProfile", + "csharp" +); +@@clientName( + VMGalleryApplication, + "ComputeBulkActionsVMGalleryApplication", + "csharp" +); +@@clientName(VmSizeProfile, "ComputeBulkActionsVmSizeProfile", "csharp"); +@@clientName( + WindowsPatchAssessmentMode, + "ComputeBulkActionsWindowsPatchAssessmentMode", + "csharp" +); +@@clientName( + WindowsVMGuestPatchAutomaticByPlatformRebootSetting, + "ComputeBulkActionsWindowsVMGuestPatchAutomaticByPlatformRebootSetting", + "csharp" +); +@@clientName( + WindowsVMGuestPatchAutomaticByPlatformSettings, + "ComputeBulkActionsWindowsVMGuestPatchAutomaticByPlatformSettings", + "csharp" +); +@@clientName( + WindowsVMGuestPatchMode, + "ComputeBulkActionsWindowsVMGuestPatchMode", + "csharp" +); +@@clientName(WinRMListener, "ComputeBulkActionsWinRMListener", "csharp"); // ===================================================================== // Warning: DateTimeOffset property naming (*On suffix) @@ -129,6 +570,11 @@ namespace Microsoft.ComputeBulkActions; // DataDisk @@clientName(DataDisk.toBeDetached, "IsToBeDetached", "csharp"); +@@clientName( + DataDisk.writeAcceleratorEnabled, + "IsWriteAcceleratorEnabled", + "csharp" +); // DiskEncryptionSettings @@clientName(DiskEncryptionSettings.enabled, "IsEnabled", "csharp"); @@ -173,6 +619,13 @@ namespace Microsoft.ComputeBulkActions; // OSImageNotificationProfile @@clientName(OSImageNotificationProfile.enable, "IsEnabled", "csharp"); +// OSDisk +@@clientName( + OSDisk.writeAcceleratorEnabled, + "IsWriteAcceleratorEnabled", + "csharp" +); + // OSProfile @@clientName( OSProfile.allowExtensionOperations, @@ -210,12 +663,34 @@ namespace Microsoft.ComputeBulkActions; @@clientName(UefiSettings.secureBootEnabled, "IsSecureBootEnabled", "csharp"); @@clientName(UefiSettings.vTpmEnabled, "IsVTpmEnabled", "csharp"); +// ScheduledEventsPolicy flattened properties +@@clientName( + UserInitiatedRedeploy.automaticallyApprove, + "IsRedeployAutomaticallyApproved", + "csharp" +); +@@clientName( + UserInitiatedReboot.automaticallyApprove, + "IsRebootAutomaticallyApproved", + "csharp" +); +@@clientName( + AllInstancesDown.automaticallyApprove, + "IsAllInstancesDownAutomaticallyApproved", + "csharp" +); + // VMGalleryApplication @@clientName( VMGalleryApplication.enableAutomaticUpgrade, "IsAutomaticUpgradeEnabled", "csharp" ); +@@clientName( + VMGalleryApplication.treatFailureAsDeploymentFailure, + "ShouldTreatFailureAsDeploymentFailure", + "csharp" +); // VirtualMachineExtensionProperties @@clientName( From 86ed062246b8e1939872eb283c4ee164cd9442f0 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Wed, 3 Jun 2026 12:45:41 -0400 Subject: [PATCH 22/22] chore: updates @azure-tools/openai-typespec (#43489) * chore: updates @azure-tools/openai-typespec package to its latest version chore: updates openai typespec definitions to 1.18 chore: switches to save exact command * docs: add READMEs for Foundry openapi3 v1 and virtual-public-preview Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> fix: rename Foundry openapi3 README.md to lowercase readme.md for Avocado Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * chore: add BYOT and MCPHTTP to ai-foundry cspell words Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * chore: refreshes generated files * Revert "docs: add READMEs for Foundry openapi3 v1 and virtual-public-preview" This reverts commit f79aed2ac46d23cf730f82ea57e0654d101ecfd6. * chore: updates openai typespec definitions to 1.19 --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- package-lock.json | 12 +- package.json | 8 +- specification/ai-foundry/cspell.yaml | 2 + .../v1/microsoft-foundry-openapi3.json | 3450 ++++++++++++++--- .../microsoft-foundry-openapi3.json | 3450 ++++++++++++++--- 5 files changed, 5860 insertions(+), 1062 deletions(-) diff --git a/package-lock.json b/package-lock.json index ccd80e4cde84..4c08384acd03 100644 --- a/package-lock.json +++ b/package-lock.json @@ -7,7 +7,7 @@ "name": "azure-rest-api-specs", "devDependencies": { "@autorest/openapi-to-typespec": "0.11.14", - "@azure-tools/openai-typespec": "1.11.0", + "@azure-tools/openai-typespec": "1.19.0", "@azure-tools/spec-gen-sdk": "~0.9.1", "@azure-tools/specs-shared": "file:.github/shared", "@azure-tools/typespec-apiview": "0.7.2", @@ -1636,14 +1636,14 @@ "link": true }, "node_modules/@azure-tools/openai-typespec": { - "version": "1.11.0", - "resolved": "https://registry.npmjs.org/@azure-tools/openai-typespec/-/openai-typespec-1.11.0.tgz", - "integrity": "sha512-xxHeThd4CJZeOZ7JPV6lPj+8vSkO7V1qZ+zodQdZdlx0jDX7tTJ9VJ5ZakZ/R7g+3sfoECIuhE0TCz+Wq6nXWA==", + "version": "1.19.0", + "resolved": "https://registry.npmjs.org/@azure-tools/openai-typespec/-/openai-typespec-1.19.0.tgz", + "integrity": "sha512-RzUTgxjZ/FgYihbHxQVKagzziJOeRb1myrA/nSLZ0xr2RNXgqz7rTercoxu2/nk6zFjnvahI8bhD+No0rIA2iA==", "dev": true, "license": "MIT", "peerDependencies": { - "@typespec/http": "*", - "@typespec/openapi": "*" + "@typespec/http": "^1.11.0", + "@typespec/openapi": "^1.11.0" } }, "node_modules/@azure-tools/openapi": { diff --git a/package.json b/package.json index 05daabac483d..006ad5988556 100644 --- a/package.json +++ b/package.json @@ -2,11 +2,10 @@ "name": "azure-rest-api-specs", "devDependencies": { "@autorest/openapi-to-typespec": "0.11.14", - "@azure-tools/openai-typespec": "1.11.0", + "@azure-tools/openai-typespec": "1.19.0", "@azure-tools/spec-gen-sdk": "~0.9.1", "@azure-tools/specs-shared": "file:.github/shared", "@azure-tools/typespec-apiview": "0.7.2", - "@azure-tools/typespec-metadata": "0.2.0", "@azure-tools/typespec-autorest": "0.68.0", "@azure-tools/typespec-azure-core": "0.68.0", "@azure-tools/typespec-azure-portal-core": "0.68.0", @@ -15,19 +14,20 @@ "@azure-tools/typespec-client-generator-cli": "0.33.1", "@azure-tools/typespec-client-generator-core": "0.68.0", "@azure-tools/typespec-liftr-base": "0.13.0", + "@azure-tools/typespec-metadata": "0.2.0", "@azure/avocado": "0.11.0", "@azure/oad": "0.12.4", "@microsoft.azure/openapi-validator": "2.2.4", "@microsoft.azure/openapi-validator-core": "1.0.7", "@microsoft.azure/openapi-validator-rulesets": "2.2.6", "@typespec/compiler": "1.12.0", - "@typespec/http": "1.12.0", - "@typespec/sse": "0.82.0", "@typespec/events": "0.82.0", + "@typespec/http": "1.12.0", "@typespec/openapi": "1.12.0", "@typespec/openapi3": "1.12.0", "@typespec/prettier-plugin-typespec": "1.12.0", "@typespec/rest": "0.82.0", + "@typespec/sse": "0.82.0", "@typespec/streams": "0.82.0", "@typespec/versioning": "0.82.0", "@typespec/xml": "0.82.0", diff --git a/specification/ai-foundry/cspell.yaml b/specification/ai-foundry/cspell.yaml index f5ae326e13de..f016163fa90c 100644 --- a/specification/ai-foundry/cspell.yaml +++ b/specification/ai-foundry/cspell.yaml @@ -56,6 +56,8 @@ overrides: - '**/specification/ai-foundry/data-plane/Foundry/preview' - '**/specification/ai-foundry/data-plane/Foundry/src' words: + - byot # Bring your own thread + - mcphttp # MCP over HTTP transport - xhigh # Image generation quality level - inpainting # Image generation concept - ilike # Comparison operator diff --git a/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.json b/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.json index 32df9df76cec..b43a0b720ac6 100644 --- a/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.json +++ b/specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.json @@ -6172,7 +6172,8 @@ }, "safety_identifier": { "type": "string", - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + "maxLength": 64, + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." }, "prompt_cache_key": { "type": "string", @@ -6184,7 +6185,7 @@ "prompt_cache_retention": { "type": "string", "enum": [ - "in-memory", + "in_memory", "24h" ], "nullable": true @@ -6210,15 +6211,6 @@ "type": "boolean", "nullable": true }, - "max_output_tokens": { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true - }, "max_tool_calls": { "type": "integer", "allOf": [ @@ -6309,6 +6301,15 @@ "nullable": true, "description": "Context management configuration for this request." }, + "max_output_tokens": { + "type": "integer", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + } + ], + "nullable": true + }, "agent_reference": { "allOf": [ { @@ -6372,7 +6373,8 @@ }, "safety_identifier": { "type": "string", - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + "maxLength": 64, + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." }, "prompt_cache_key": { "type": "string", @@ -6384,7 +6386,7 @@ "prompt_cache_retention": { "type": "string", "enum": [ - "in-memory", + "in_memory", "24h" ], "nullable": true @@ -6410,15 +6412,6 @@ "type": "boolean", "nullable": true }, - "max_output_tokens": { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true - }, "max_tool_calls": { "type": "integer", "allOf": [ @@ -6509,6 +6502,15 @@ "nullable": true, "description": "Context management configuration for this request." }, + "max_output_tokens": { + "type": "integer", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + } + ], + "nullable": true + }, "agent_reference": { "allOf": [ { @@ -7614,6 +7616,48 @@ "Schedules" ] } + }, + "/{jobId}": { + "delete": { + "operationId": "deleteJob", + "description": "Delete a job. Returns 204 No Content.", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "description": "The ID of the job to delete.", + "schema": { + "type": "string" + } + }, + { + "name": "api-version", + "in": "query", + "required": true, + "description": "The API version to use for this operation.", + "schema": { + "type": "string" + }, + "explode": false + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful." + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } } }, "security": [ @@ -10344,7 +10388,9 @@ }, "discriminator": { "propertyName": "type", - "mapping": {} + "mapping": { + "azure_ai_source": "#/components/schemas/AzureAIDataSourceConfig" + } }, "description": "Base class for run data sources with discriminator support." }, @@ -13019,7 +13065,8 @@ "red_team": "#/components/schemas/RedTeamItemGenerationParams", "red_team_seed_prompts": "#/components/schemas/RedTeamSeedPromptsItemGenerationParams", "red_team_taxonomy": "#/components/schemas/RedTeamTaxonomyItemGenerationParams", - "response_retrieval": "#/components/schemas/ResponseRetrievalItemGenerationParams" + "response_retrieval": "#/components/schemas/ResponseRetrievalItemGenerationParams", + "synthetic_data_gen_preview": "#/components/schemas/SyntheticDataGenerationPreviewItemGenerationParams" } }, "description": "Represents the set of parameters used to control item generation operations." @@ -14504,6 +14551,12 @@ "OpenAI.ChatModel": { "type": "string", "enum": [ + "gpt-5.4", + "gpt-5.4-mini", + "gpt-5.4-nano", + "gpt-5.4-mini-2026-03-17", + "gpt-5.4-nano-2026-03-17", + "gpt-5.3-chat-latest", "gpt-5.2", "gpt-5.2-2025-12-11", "gpt-5.2-chat-latest", @@ -14629,6 +14682,13 @@ } ], "description": "The y-coordinate where the click occurred." + }, + "keys": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } }, "allOf": [ @@ -14798,6 +14858,26 @@ "instructions": { "type": "string", "nullable": true + }, + "prompt_cache_key": { + "type": "string", + "nullable": true + }, + "prompt_cache_retention": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.PromptCacheRetentionEnum" + } + ], + "nullable": true + }, + "service_tier": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ServiceTierEnum" + } + ], + "nullable": true } } }, @@ -14817,7 +14897,9 @@ "gt", "gte", "lt", - "lte" + "lte", + "in", + "nin" ], "description": "Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.\n - `eq`: equals\n - `ne`: not equal\n - `gt`: greater than\n - `gte`: greater than or equal\n - `lt`: less than\n - `lte`: less than or equal\n - `in`: in\n - `nin`: not in", "default": "eq" @@ -14919,6 +15001,14 @@ } } }, + "OpenAI.ComputerActionList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerAction" + }, + "description": "Flattened batched actions for `computer_use`. Each action includes an\n`type` discriminator and action-specific fields.", + "title": "Computer Action List" + }, "OpenAI.ComputerActionType": { "anyOf": [ { @@ -14976,7 +15066,8 @@ "required": [ "type", "image_url", - "file_id" + "file_id", + "detail" ], "properties": { "type": { @@ -14996,6 +15087,14 @@ "file_id": { "type": "string", "nullable": true + }, + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ImageDetail" + } + ], + "description": "The detail level of the screenshot image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -15033,6 +15132,30 @@ }, "description": "A computer screenshot image used with the computer use tool." }, + "OpenAI.ComputerTool": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer" + ], + "description": "The type of the computer tool. Always `computer`.", + "x-stainless-const": true, + "default": "computer" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Tool" + } + ], + "description": "A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).", + "title": "Computer" + }, "OpenAI.ComputerUsePreviewTool": { "type": "object", "required": [ @@ -15222,14 +15345,6 @@ }, "minItems": 1, "description": "A list of allowed domains when type is `allowlist`." - }, - "domain_secrets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ContainerNetworkPolicyDomainSecretParam" - }, - "minItems": 1, - "description": "Optional domain-scoped secrets for allowlisted domains." } }, "allOf": [ @@ -15260,32 +15375,6 @@ } ] }, - "OpenAI.ContainerNetworkPolicyDomainSecretParam": { - "type": "object", - "required": [ - "domain", - "name", - "value" - ], - "properties": { - "domain": { - "type": "string", - "minLength": 1, - "description": "The domain associated with the secret." - }, - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the secret to inject for the domain." - }, - "value": { - "type": "string", - "minLength": 1, - "maxLength": 10485760, - "description": "The secret value to inject for the domain." - } - } - }, "OpenAI.ContainerNetworkPolicyParam": { "type": "object", "required": [ @@ -15414,14 +15503,17 @@ "propertyName": "type", "mapping": { "message": "#/components/schemas/OpenAI.ConversationItemMessage", - "function_call": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallResource", - "function_call_output": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutputResource", + "function_call": "#/components/schemas/OpenAI.ConversationItemFunctionToolCall", + "function_call_output": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutput", "file_search_call": "#/components/schemas/OpenAI.ConversationItemFileSearchToolCall", "web_search_call": "#/components/schemas/OpenAI.ConversationItemWebSearchToolCall", "image_generation_call": "#/components/schemas/OpenAI.ConversationItemImageGenToolCall", "computer_call": "#/components/schemas/OpenAI.ConversationItemComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ConversationItemComputerToolCallOutputResource", + "computer_call_output": "#/components/schemas/OpenAI.ConversationItemComputerToolCallOutput", + "tool_search_call": "#/components/schemas/OpenAI.ConversationItemToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.ConversationItemToolSearchOutput", "reasoning": "#/components/schemas/OpenAI.ConversationItemReasoningItem", + "compaction": "#/components/schemas/OpenAI.ConversationItemCompactionBody", "code_interpreter_call": "#/components/schemas/OpenAI.ConversationItemCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.ConversationItemLocalShellToolCall", "local_shell_call_output": "#/components/schemas/OpenAI.ConversationItemLocalShellToolCallOutput", @@ -15433,8 +15525,8 @@ "mcp_approval_request": "#/components/schemas/OpenAI.ConversationItemMcpApprovalRequest", "mcp_approval_response": "#/components/schemas/OpenAI.ConversationItemMcpApprovalResponseResource", "mcp_call": "#/components/schemas/OpenAI.ConversationItemMcpToolCall", - "custom_tool_call": "#/components/schemas/OpenAI.ConversationItemCustomToolCall", - "custom_tool_call_output": "#/components/schemas/OpenAI.ConversationItemCustomToolCallOutput" + "custom_tool_call": "#/components/schemas/OpenAI.ConversationItemCustomToolCallResource", + "custom_tool_call_output": "#/components/schemas/OpenAI.ConversationItemCustomToolCallOutputResource" } }, "description": "A single item within a conversation. The set of possible types are the same as the `output` type of a [Response object](/docs/api-reference/responses/object#responses/object-output).", @@ -15614,13 +15706,50 @@ "description": "A tool call to run code.", "title": "Code interpreter tool call" }, + "OpenAI.ConversationItemCompactionBody": { + "type": "object", + "required": [ + "type", + "id", + "encrypted_content" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "compaction" + ], + "description": "The type of the item. Always `compaction`.", + "x-stainless-const": true, + "default": "compaction" + }, + "id": { + "type": "string", + "description": "The unique ID of the compaction item." + }, + "encrypted_content": { + "type": "string", + "description": "The encrypted content that was produced by compaction." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ], + "description": "A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact).", + "title": "Compaction item" + }, "OpenAI.ConversationItemComputerToolCall": { "type": "object", "required": [ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -15644,6 +15773,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -15669,10 +15801,11 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ConversationItemComputerToolCallOutputResource": { + "OpenAI.ConversationItemComputerToolCallOutput": { "type": "object", "required": [ "type", + "id", "call_id", "output" ], @@ -15688,7 +15821,8 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output." + "description": "The ID of the computer tool call output.", + "readOnly": true }, "call_id": { "type": "string", @@ -15718,40 +15852,60 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ] + ], + "description": "The output of a computer tool call.", + "title": "Computer tool call output" }, - "OpenAI.ConversationItemCustomToolCall": { + "OpenAI.ConversationItemCustomToolCallOutputResource": { "type": "object", "required": [ "type", "call_id", - "name", - "input" + "output", + "status" ], "properties": { "type": { "type": "string", "enum": [ - "custom_tool_call" + "custom_tool_call_output" ], - "description": "The type of the custom tool call. Always `custom_tool_call`.", + "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", "x-stainless-const": true }, "id": { "type": "string", - "description": "The unique ID of the custom tool call in the OpenAI platform." + "description": "The unique ID of the custom tool call output in the OpenAI platform." }, "call_id": { "type": "string", - "description": "An identifier used to map this custom tool call to a tool call output." + "description": "The call ID, used to map this custom tool call output to a custom tool call." }, - "name": { - "type": "string", - "description": "The name of the custom tool being called." + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." }, - "input": { + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { "type": "string", - "description": "The input for the custom tool call generated by the model." + "description": "The identifier of the actor that created the item." } }, "allOf": [ @@ -15759,46 +15913,57 @@ "$ref": "#/components/schemas/OpenAI.ConversationItem" } ], - "description": "A call to a custom tool created by the model.", - "title": "Custom tool call" + "title": "ResponseCustomToolCallOutputItem" }, - "OpenAI.ConversationItemCustomToolCallOutput": { + "OpenAI.ConversationItemCustomToolCallResource": { "type": "object", "required": [ "type", "call_id", - "output" + "name", + "input", + "status" ], "properties": { "type": { "type": "string", "enum": [ - "custom_tool_call_output" + "custom_tool_call" ], - "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", + "description": "The type of the custom tool call. Always `custom_tool_call`.", "x-stainless-const": true }, "id": { "type": "string", - "description": "The unique ID of the custom tool call output in the OpenAI platform." + "description": "The unique ID of the custom tool call in the OpenAI platform." }, "call_id": { "type": "string", - "description": "The call ID, used to map this custom tool call output to a custom tool call." + "description": "An identifier used to map this custom tool call to a tool call output." }, - "output": { - "oneOf": [ - { - "type": "string" - }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, + "name": { + "type": "string", + "description": "The name of the custom tool being called." + }, + "input": { + "type": "string", + "description": "The input for the custom tool call generated by the model." + }, + "status": { + "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" } ], - "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." } }, "allOf": [ @@ -15806,8 +15971,7 @@ "$ref": "#/components/schemas/OpenAI.ConversationItem" } ], - "description": "The output of a custom tool call from your code, being sent back to the model.", - "title": "Custom tool call output" + "title": "ResponseCustomToolCallItem" }, "OpenAI.ConversationItemFileSearchToolCall": { "type": "object", @@ -15903,7 +16067,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." @@ -15961,7 +16125,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -15995,43 +16159,44 @@ "description": "The output of a shell tool call that was emitted.", "title": "Shell call output" }, - "OpenAI.ConversationItemFunctionToolCallOutputResource": { + "OpenAI.ConversationItemFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", - "output" + "name", + "arguments" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", "enum": [ - "function_call_output" + "function_call" ], - "description": "The type of the function tool call output. Always `function_call_output`.", + "description": "The type of the function tool call. Always `function_call`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "output": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } - } - ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, + "name": { + "type": "string", + "description": "The name of the function to run." + }, + "arguments": { + "type": "string", + "description": "A JSON string of the arguments to pass to the function." }, "status": { "type": "string", @@ -16047,40 +16212,49 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ] + ], + "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", + "title": "Function tool call" }, - "OpenAI.ConversationItemFunctionToolCallResource": { + "OpenAI.ConversationItemFunctionToolCallOutput": { "type": "object", "required": [ + "id", "type", "call_id", - "name", - "arguments" + "output" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true }, "type": { "type": "string", "enum": [ - "function_call" + "function_call_output" ], - "description": "The type of the function tool call. Always `function_call`.", + "description": "The type of the function tool call output. Always `function_call_output`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "name": { - "type": "string", - "description": "The name of the function to run." - }, - "arguments": { - "type": "string", - "description": "A JSON string of the arguments to pass to the function." + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." }, "status": { "type": "string", @@ -16096,7 +16270,9 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ] + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" }, "OpenAI.ConversationItemImageGenToolCall": { "type": "object", @@ -16396,8 +16572,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -16516,6 +16691,14 @@ "$ref": "#/components/schemas/OpenAI.MessageContent" }, "description": "The content of the message" + }, + "phase": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + } + ], + "nullable": true } }, "allOf": [ @@ -16582,6 +16765,126 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, + "OpenAI.ConversationItemToolSearchCall": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "arguments", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search call item." + }, + "call_id": { + "type": "string", + "nullable": true + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ] + }, + "OpenAI.ConversationItemToolSearchOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "tools", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search output item." + }, + "call_id": { + "type": "string", + "nullable": true + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by tool search." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ] + }, "OpenAI.ConversationItemType": { "anyOf": [ { @@ -16598,7 +16901,10 @@ "image_generation_call", "computer_call", "computer_call_output", + "tool_search_call", + "tool_search_output", "reasoning", + "compaction", "code_interpreter_call", "local_shell_call", "local_shell_call_output", @@ -16787,7 +17093,8 @@ "propertyName": "type", "mapping": { "text": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText", - "json_object": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject" + "json_object": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject", + "json_schema": "#/components/schemas/OpenAI.ResponseFormatJsonSchema" } }, "description": "An object specifying the format that the model must output.\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables\nStructured Outputs which ensures the model will match your supplied JSON\nschema. Learn more in the [Structured Outputs\nguide](/docs/guides/structured-outputs).\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it." @@ -17756,6 +18063,10 @@ } ], "description": "The input format for the custom tool. Default is unconstrained text." + }, + "defer_loading": { + "type": "boolean", + "description": "Whether this tool should be deferred and discovered via tool search." } }, "allOf": [ @@ -17828,7 +18139,8 @@ "enum": [ "low", "high", - "auto" + "auto", + "original" ] }, "OpenAI.DoubleClickAction": { @@ -17836,7 +18148,8 @@ "required": [ "type", "x", - "y" + "y", + "keys" ], "properties": { "type": { @@ -17863,6 +18176,13 @@ } ], "description": "The y-coordinate where the double click occurred." + }, + "keys": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } }, "allOf": [ @@ -17895,6 +18215,13 @@ "$ref": "#/components/schemas/OpenAI.CoordParam" }, "description": "An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg\n ```\n [\n { x: 100, y: 200 },\n { x: 200, y: 300 }\n ]\n ```" + }, + "keys": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } }, "allOf": [ @@ -17934,6 +18261,14 @@ ], "description": "Text, image, or audio input to the model, used to generate a response.\n Can also contain previous assistant responses." }, + "phase": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + } + ], + "nullable": true + }, "type": { "type": "string", "enum": [ @@ -17960,6 +18295,9 @@ "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role. Messages with the\n`assistant` role are presumed to have been generated by the model in previous\ninteractions.", "title": "Input message" }, + "OpenAI.EmptyModelParam": { + "type": "object" + }, "OpenAI.Error": { "type": "object", "required": [ @@ -18927,6 +19265,13 @@ "description": "A citation to a file.", "title": "File citation" }, + "OpenAI.FileInputDetail": { + "type": "string", + "enum": [ + "low", + "high" + ] + }, "OpenAI.FilePath": { "type": "object", "required": [ @@ -19825,14 +20170,22 @@ "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "allOf": [ @@ -19874,7 +20227,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -19937,14 +20290,30 @@ "incomplete" ] }, - "OpenAI.FunctionObject": { - "type": "object", - "required": [ - "name" - ], - "properties": { - "description": { - "type": "string", + "OpenAI.FunctionCallOutputStatusEnum": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + "OpenAI.FunctionCallStatus": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + "OpenAI.FunctionObject": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "description": { + "type": "string", "description": "A description of what the function does, used by the model to choose when and how to call the function." }, "name": { @@ -20365,6 +20734,14 @@ } ] }, + "OpenAI.FunctionShellCallOutputStatusEnum": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, "OpenAI.FunctionShellCallOutputTimeoutOutcome": { "type": "object", "required": [ @@ -20413,6 +20790,14 @@ "description": "Indicates that the shell call exceeded its configured time limit.", "title": "Shell call timeout outcome" }, + "OpenAI.FunctionShellCallStatus": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, "OpenAI.FunctionShellToolParam": { "type": "object", "required": [ @@ -20571,6 +20956,10 @@ "strict": { "type": "boolean", "nullable": true + }, + "defer_loading": { + "type": "boolean", + "description": "Whether this function is deferred and loaded via tool search." } }, "allOf": [ @@ -20581,61 +20970,49 @@ "description": "Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).", "title": "Function" }, - "OpenAI.FunctionToolCallOutput": { + "OpenAI.FunctionToolParam": { "type": "object", "required": [ - "type", - "call_id", - "output" + "name", + "type" ], "properties": { - "id": { - "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." - }, - "type": { + "name": { "type": "string", - "enum": [ - "function_call_output" - ], - "description": "The type of the function tool call output. Always `function_call_output`.", - "x-stainless-const": true + "minLength": 1, + "maxLength": 128, + "pattern": "^[a-zA-Z0-9_-]+$" }, - "call_id": { + "description": { "type": "string", - "description": "The unique ID of the function tool call generated by the model." + "nullable": true }, - "output": { - "oneOf": [ - { - "type": "string" - }, + "parameters": { + "type": "object", + "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" } ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + "nullable": true }, - "status": { + "strict": { + "type": "boolean", + "nullable": true + }, + "type": { "type": "string", "enum": [ - "in_progress", - "completed", - "incomplete" + "function" ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemField" + "x-stainless-const": true, + "default": "function" + }, + "defer_loading": { + "type": "boolean", + "description": "Whether this function should be deferred and discovered via tool search." } - ], - "description": "The output of a function tool call.", - "title": "Function tool call output" + } }, "OpenAI.GraderLabelModel": { "type": "object", @@ -20983,7 +21360,8 @@ "enum": [ "low", "high", - "auto" + "auto", + "original" ] }, "OpenAI.ImageGenActionEnum": { @@ -21037,14 +21415,21 @@ "default": "auto" }, "size": { - "type": "string", - "enum": [ - "1024x1024", - "1024x1536", - "1536x1024", - "auto" + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "1024x1024", + "1024x1536", + "1536x1024", + "auto" + ] + } ], - "description": "The size of the generated image. One of `1024x1024`, `1024x1536`,\n `1536x1024`, or `auto`. Default: `auto`.", + "description": "The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.", "default": "auto" }, "output_format": { @@ -21162,7 +21547,7 @@ ] } ], - "description": "Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program)." + "description": "Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.results`: Include the search results of the web search tool call.\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program)." }, "OpenAI.InlineSkillParam": { "type": "object", @@ -21328,14 +21713,22 @@ "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "allOf": [ @@ -21377,7 +21770,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -21463,14 +21856,22 @@ "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "description": "A file input to the model.", @@ -21507,6 +21908,14 @@ "type": "string", "format": "uri", "nullable": true + }, + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "description": "A file input to the model.", @@ -21543,7 +21952,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "description": "An image input to the model. Learn about [image inputs](/docs/guides/vision).", @@ -21607,6 +22016,8 @@ "web_search_call": "#/components/schemas/OpenAI.InputItemWebSearchToolCall", "function_call": "#/components/schemas/OpenAI.InputItemFunctionToolCall", "function_call_output": "#/components/schemas/OpenAI.InputItemFunctionCallOutputItemParam", + "tool_search_call": "#/components/schemas/OpenAI.InputItemToolSearchCallItemParam", + "tool_search_output": "#/components/schemas/OpenAI.InputItemToolSearchOutputItemParam", "reasoning": "#/components/schemas/OpenAI.InputItemReasoningItem", "compaction": "#/components/schemas/OpenAI.InputItemCompactionSummaryItemParam", "image_generation_call": "#/components/schemas/OpenAI.InputItemImageGenToolCall", @@ -21888,7 +22299,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -21912,6 +22322,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -21962,6 +22375,10 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -22273,6 +22690,7 @@ "OpenAI.InputItemFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", "name", @@ -22281,7 +22699,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", @@ -22295,6 +22714,10 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, "name": { "type": "string", "description": "The name of the function to run." @@ -22571,8 +22994,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -22683,6 +23105,14 @@ }, "description": "The content of the output message." }, + "phase": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + } + ], + "nullable": true + }, "status": { "type": "string", "enum": [ @@ -22757,6 +23187,115 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, + "OpenAI.InputItemToolSearchCallItemParam": { + "type": "object", + "required": [ + "type", + "arguments" + ], + "properties": { + "id": { + "type": "string", + "nullable": true + }, + "call_id": { + "type": "string", + "nullable": true + }, + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The item type. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" + } + ], + "description": "The arguments supplied to the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + } + ], + "nullable": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.InputItem" + } + ] + }, + "OpenAI.InputItemToolSearchOutputItemParam": { + "type": "object", + "required": [ + "type", + "tools" + ], + "properties": { + "id": { + "type": "string", + "nullable": true + }, + "call_id": { + "type": "string", + "nullable": true + }, + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The item type. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by the tool search output." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + } + ], + "nullable": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.InputItem" + } + ] + }, "OpenAI.InputItemType": { "anyOf": [ { @@ -22773,6 +23312,8 @@ "web_search_call", "function_call", "function_call_output", + "tool_search_call", + "tool_search_output", "reasoning", "compaction", "image_generation_call", @@ -22848,52 +23389,6 @@ "description": "The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.", "title": "Web search tool call" }, - "OpenAI.InputMessage": { - "type": "object", - "required": [ - "type", - "role", - "content" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "message" - ], - "description": "The type of the message input. Always set to `message`.", - "x-stainless-const": true - }, - "role": { - "type": "string", - "enum": [ - "user", - "system", - "developer" - ], - "description": "The role of the message input. One of `user`, `system`, or `developer`." - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "content": { - "$ref": "#/components/schemas/OpenAI.InputMessageContentList" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Item" - } - ], - "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", - "title": "Input message" - }, "OpenAI.InputMessageContentList": { "type": "array", "items": { @@ -22902,55 +23397,6 @@ "description": "A list of one or many input items to the model, containing different content\ntypes.", "title": "Input item content list" }, - "OpenAI.InputMessageResource": { - "type": "object", - "required": [ - "type", - "role", - "content", - "id" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "message" - ], - "description": "The type of the message input. Always set to `message`.", - "x-stainless-const": true - }, - "role": { - "type": "string", - "enum": [ - "user", - "system", - "developer" - ], - "description": "The role of the message input. One of `user`, `system`, or `developer`." - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "content": { - "$ref": "#/components/schemas/OpenAI.InputMessageContentList" - }, - "id": { - "type": "string", - "description": "The unique ID of the message input." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemResource" - } - ] - }, "OpenAI.InputParam": { "oneOf": [ { @@ -23028,7 +23474,7 @@ "propertyName": "type", "mapping": { "memory_search_call": "#/components/schemas/MemorySearchToolCallItemParam", - "message": "#/components/schemas/OpenAI.InputMessage", + "message": "#/components/schemas/OpenAI.ItemInputMessage", "output_message": "#/components/schemas/OpenAI.ItemOutputMessage", "file_search_call": "#/components/schemas/OpenAI.ItemFileSearchToolCall", "computer_call": "#/components/schemas/OpenAI.ItemComputerToolCall", @@ -23036,6 +23482,8 @@ "web_search_call": "#/components/schemas/OpenAI.ItemWebSearchToolCall", "function_call": "#/components/schemas/OpenAI.ItemFunctionToolCall", "function_call_output": "#/components/schemas/OpenAI.ItemFunctionCallOutputItemParam", + "tool_search_call": "#/components/schemas/OpenAI.ItemToolSearchCallItemParam", + "tool_search_output": "#/components/schemas/OpenAI.ItemToolSearchOutputItemParam", "reasoning": "#/components/schemas/OpenAI.ItemReasoningItem", "compaction": "#/components/schemas/OpenAI.ItemCompactionSummaryItemParam", "image_generation_call": "#/components/schemas/OpenAI.ItemImageGenToolCall", @@ -23317,7 +23765,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -23341,6 +23788,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -23391,6 +23841,10 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -23468,14 +23922,16 @@ "discriminator": { "propertyName": "type", "mapping": { - "function_call_output": "#/components/schemas/OpenAI.FunctionToolCallOutput", "message": "#/components/schemas/OpenAI.ItemFieldMessage", "function_call": "#/components/schemas/OpenAI.ItemFieldFunctionToolCall", + "tool_search_call": "#/components/schemas/OpenAI.ItemFieldToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.ItemFieldToolSearchOutput", + "function_call_output": "#/components/schemas/OpenAI.ItemFieldFunctionToolCallOutput", "file_search_call": "#/components/schemas/OpenAI.ItemFieldFileSearchToolCall", "web_search_call": "#/components/schemas/OpenAI.ItemFieldWebSearchToolCall", "image_generation_call": "#/components/schemas/OpenAI.ItemFieldImageGenToolCall", "computer_call": "#/components/schemas/OpenAI.ItemFieldComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ItemFieldComputerToolCallOutputResource", + "computer_call_output": "#/components/schemas/OpenAI.ItemFieldComputerToolCallOutput", "reasoning": "#/components/schemas/OpenAI.ItemFieldReasoningItem", "compaction": "#/components/schemas/OpenAI.ItemFieldCompactionBody", "code_interpreter_call": "#/components/schemas/OpenAI.ItemFieldCodeInterpreterToolCall", @@ -23713,7 +24169,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -23737,6 +24192,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -23762,10 +24220,11 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ItemFieldComputerToolCallOutputResource": { + "OpenAI.ItemFieldComputerToolCallOutput": { "type": "object", "required": [ "type", + "id", "call_id", "output" ], @@ -23781,7 +24240,8 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output." + "description": "The ID of the computer tool call output.", + "readOnly": true }, "call_id": { "type": "string", @@ -23811,7 +24271,9 @@ { "$ref": "#/components/schemas/OpenAI.ItemField" } - ] + ], + "description": "The output of a computer tool call.", + "title": "Computer tool call output" }, "OpenAI.ItemFieldCustomToolCall": { "type": "object", @@ -23838,6 +24300,10 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -23996,7 +24462,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." @@ -24054,7 +24520,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -24091,6 +24557,7 @@ "OpenAI.ItemFieldFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", "name", @@ -24099,7 +24566,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", @@ -24113,6 +24581,10 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, "name": { "type": "string", "description": "The name of the function to run." @@ -24139,6 +24611,64 @@ "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", "title": "Function tool call" }, + "OpenAI.ItemFieldFunctionToolCallOutput": { + "type": "object", + "required": [ + "id", + "type", + "call_id", + "output" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true + }, + "type": { + "type": "string", + "enum": [ + "function_call_output" + ], + "description": "The type of the function tool call output. Always `function_call_output`.", + "x-stainless-const": true + }, + "call_id": { + "type": "string", + "description": "The unique ID of the function tool call generated by the model." + }, + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" + }, "OpenAI.ItemFieldImageGenToolCall": { "type": "object", "required": [ @@ -24390,8 +24920,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -24510,6 +25039,14 @@ "$ref": "#/components/schemas/OpenAI.MessageContent" }, "description": "The content of the message" + }, + "phase": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + } + ], + "nullable": true } }, "allOf": [ @@ -24576,93 +25113,215 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, - "OpenAI.ItemFieldType": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "enum": [ - "message", - "function_call", - "function_call_output", - "file_search_call", - "web_search_call", - "image_generation_call", - "computer_call", - "computer_call_output", - "reasoning", - "compaction", - "code_interpreter_call", - "local_shell_call", - "local_shell_call_output", - "shell_call", - "shell_call_output", - "apply_patch_call", - "apply_patch_call_output", - "mcp_list_tools", - "mcp_approval_request", - "mcp_approval_response", - "mcp_call", - "custom_tool_call", - "custom_tool_call_output" - ] - } - ] - }, - "OpenAI.ItemFieldWebSearchToolCall": { + "OpenAI.ItemFieldToolSearchCall": { "type": "object", "required": [ - "id", "type", - "status", - "action" + "id", + "call_id", + "execution", + "arguments", + "status" ], "properties": { - "id": { - "type": "string", - "description": "The unique ID of the web search tool call." - }, "type": { "type": "string", "enum": [ - "web_search_call" + "tool_search_call" ], - "description": "The type of the web search tool call. Always `web_search_call`.", - "x-stainless-const": true + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" }, - "status": { + "id": { "type": "string", - "enum": [ - "in_progress", - "searching", - "completed", - "failed" - ], - "description": "The status of the web search tool call." + "description": "The unique ID of the tool search call item." }, - "action": { - "oneOf": [ - { - "$ref": "#/components/schemas/OpenAI.WebSearchActionSearch" - }, + "call_id": { + "type": "string", + "nullable": true + }, + "execution": { + "allOf": [ { - "$ref": "#/components/schemas/OpenAI.WebSearchActionOpenPage" - }, + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ { - "$ref": "#/components/schemas/OpenAI.WebSearchActionFind" + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" } ], - "description": "An object describing the specific action taken in this web search call.\n Includes details on how the model used the web (search, open_page, find_in_page)." + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." } }, "allOf": [ { "$ref": "#/components/schemas/OpenAI.ItemField" } - ], - "description": "The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.", + ] + }, + "OpenAI.ItemFieldToolSearchOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "tools", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search output item." + }, + "call_id": { + "type": "string", + "nullable": true + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by tool search." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ] + }, + "OpenAI.ItemFieldType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "message", + "function_call", + "tool_search_call", + "tool_search_output", + "function_call_output", + "file_search_call", + "web_search_call", + "image_generation_call", + "computer_call", + "computer_call_output", + "reasoning", + "compaction", + "code_interpreter_call", + "local_shell_call", + "local_shell_call_output", + "shell_call", + "shell_call_output", + "apply_patch_call", + "apply_patch_call_output", + "mcp_list_tools", + "mcp_approval_request", + "mcp_approval_response", + "mcp_call", + "custom_tool_call", + "custom_tool_call_output" + ] + } + ] + }, + "OpenAI.ItemFieldWebSearchToolCall": { + "type": "object", + "required": [ + "id", + "type", + "status", + "action" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the web search tool call." + }, + "type": { + "type": "string", + "enum": [ + "web_search_call" + ], + "description": "The type of the web search tool call. Always `web_search_call`.", + "x-stainless-const": true + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "searching", + "completed", + "failed" + ], + "description": "The status of the web search tool call." + }, + "action": { + "oneOf": [ + { + "$ref": "#/components/schemas/OpenAI.WebSearchActionSearch" + }, + { + "$ref": "#/components/schemas/OpenAI.WebSearchActionOpenPage" + }, + { + "$ref": "#/components/schemas/OpenAI.WebSearchActionFind" + } + ], + "description": "An object describing the specific action taken in this web search call.\n Includes details on how the model used the web (search, open_page, find_in_page)." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ], + "description": "The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.", "title": "Web search tool call" }, "OpenAI.ItemFileSearchToolCall": { @@ -24912,6 +25571,7 @@ "OpenAI.ItemFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", "name", @@ -24920,7 +25580,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", @@ -24934,6 +25595,10 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, "name": { "type": "string", "description": "The name of the function to run." @@ -25004,6 +25669,59 @@ "description": "An image generation request made by the model.", "title": "Image generation call" }, + "OpenAI.ItemInputMessage": { + "type": "object", + "required": [ + "type", + "role", + "content", + "id" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "message" + ], + "description": "The type of the message input. Always set to `message`.", + "x-stainless-const": true, + "default": "message" + }, + "role": { + "type": "string", + "enum": [ + "user", + "system", + "developer" + ], + "description": "The role of the message input. One of `user`, `system`, or `developer`." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "content": { + "$ref": "#/components/schemas/OpenAI.InputMessageContentList" + }, + "id": { + "type": "string", + "description": "The unique ID of the message input.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ], + "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", + "title": "Input message" + }, "OpenAI.ItemLocalShellToolCall": { "type": "object", "required": [ @@ -25210,8 +25928,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -25322,6 +26039,14 @@ }, "description": "The content of the output message." }, + "phase": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + } + ], + "nullable": true + }, "status": { "type": "string", "enum": [ @@ -25438,14 +26163,18 @@ "discriminator": { "propertyName": "type", "mapping": { - "message": "#/components/schemas/OpenAI.InputMessageResource", + "message": "#/components/schemas/OpenAI.ItemResourceInputMessage", "output_message": "#/components/schemas/OpenAI.ItemResourceOutputMessage", "file_search_call": "#/components/schemas/OpenAI.ItemResourceFileSearchToolCall", "computer_call": "#/components/schemas/OpenAI.ItemResourceComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ItemResourceComputerToolCallOutputResource", + "computer_call_output": "#/components/schemas/OpenAI.ItemResourceComputerToolCallOutput", "web_search_call": "#/components/schemas/OpenAI.ItemResourceWebSearchToolCall", - "function_call": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallResource", - "function_call_output": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutputResource", + "function_call": "#/components/schemas/OpenAI.ItemResourceFunctionToolCall", + "function_call_output": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutput", + "tool_search_call": "#/components/schemas/OpenAI.ItemResourceToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.ItemResourceToolSearchOutput", + "reasoning": "#/components/schemas/OpenAI.ItemResourceReasoningItem", + "compaction": "#/components/schemas/OpenAI.ItemResourceCompactionBody", "image_generation_call": "#/components/schemas/OpenAI.ItemResourceImageGenToolCall", "code_interpreter_call": "#/components/schemas/OpenAI.ItemResourceCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.ItemResourceLocalShellToolCall", @@ -25457,7 +26186,9 @@ "mcp_list_tools": "#/components/schemas/OpenAI.ItemResourceMcpListTools", "mcp_approval_request": "#/components/schemas/OpenAI.ItemResourceMcpApprovalRequest", "mcp_approval_response": "#/components/schemas/OpenAI.ItemResourceMcpApprovalResponseResource", - "mcp_call": "#/components/schemas/OpenAI.ItemResourceMcpToolCall" + "mcp_call": "#/components/schemas/OpenAI.ItemResourceMcpToolCall", + "custom_tool_call": "#/components/schemas/OpenAI.ItemResourceCustomToolCallResource", + "custom_tool_call_output": "#/components/schemas/OpenAI.ItemResourceCustomToolCallOutputResource" } }, "description": "Content item used to generate a response." @@ -25636,13 +26367,50 @@ "description": "A tool call to run code.", "title": "Code interpreter tool call" }, + "OpenAI.ItemResourceCompactionBody": { + "type": "object", + "required": [ + "type", + "id", + "encrypted_content" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "compaction" + ], + "description": "The type of the item. Always `compaction`.", + "x-stainless-const": true, + "default": "compaction" + }, + "id": { + "type": "string", + "description": "The unique ID of the compaction item." + }, + "encrypted_content": { + "type": "string", + "description": "The encrypted content that was produced by compaction." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "description": "A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact).", + "title": "Compaction item" + }, "OpenAI.ItemResourceComputerToolCall": { "type": "object", "required": [ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -25666,6 +26434,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -25691,10 +26462,11 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ItemResourceComputerToolCallOutputResource": { + "OpenAI.ItemResourceComputerToolCallOutput": { "type": "object", "required": [ "type", + "id", "call_id", "output" ], @@ -25710,7 +26482,8 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output." + "description": "The ID of the computer tool call output.", + "readOnly": true }, "call_id": { "type": "string", @@ -25740,20 +26513,139 @@ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ] + ], + "description": "The output of a computer tool call.", + "title": "Computer tool call output" }, - "OpenAI.ItemResourceFileSearchToolCall": { + "OpenAI.ItemResourceCustomToolCallOutputResource": { "type": "object", "required": [ - "id", "type", - "status", - "queries" + "call_id", + "output", + "status" ], "properties": { - "id": { + "type": { "type": "string", - "description": "The unique ID of the file search tool call." + "enum": [ + "custom_tool_call_output" + ], + "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the custom tool call output in the OpenAI platform." + }, + "call_id": { + "type": "string", + "description": "The call ID, used to map this custom tool call output to a custom tool call." + }, + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "title": "ResponseCustomToolCallOutputItem" + }, + "OpenAI.ItemResourceCustomToolCallResource": { + "type": "object", + "required": [ + "type", + "call_id", + "name", + "input", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "custom_tool_call" + ], + "description": "The type of the custom tool call. Always `custom_tool_call`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the custom tool call in the OpenAI platform." + }, + "call_id": { + "type": "string", + "description": "An identifier used to map this custom tool call to a tool call output." + }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, + "name": { + "type": "string", + "description": "The name of the custom tool being called." + }, + "input": { + "type": "string", + "description": "The input for the custom tool call generated by the model." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "title": "ResponseCustomToolCallItem" + }, + "OpenAI.ItemResourceFileSearchToolCall": { + "type": "object", + "required": [ + "id", + "type", + "status", + "queries" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the file search tool call." }, "type": { "type": "string", @@ -25836,7 +26728,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." @@ -25894,7 +26786,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -25928,43 +26820,44 @@ "description": "The output of a shell tool call that was emitted.", "title": "Shell call output" }, - "OpenAI.ItemResourceFunctionToolCallOutputResource": { + "OpenAI.ItemResourceFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", - "output" + "name", + "arguments" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", "enum": [ - "function_call_output" + "function_call" ], - "description": "The type of the function tool call output. Always `function_call_output`.", + "description": "The type of the function tool call. Always `function_call`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "output": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } - } - ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, + "name": { + "type": "string", + "description": "The name of the function to run." + }, + "arguments": { + "type": "string", + "description": "A JSON string of the arguments to pass to the function." }, "status": { "type": "string", @@ -25980,40 +26873,49 @@ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ] + ], + "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", + "title": "Function tool call" }, - "OpenAI.ItemResourceFunctionToolCallResource": { + "OpenAI.ItemResourceFunctionToolCallOutput": { "type": "object", "required": [ + "id", "type", "call_id", - "name", - "arguments" + "output" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true }, "type": { "type": "string", "enum": [ - "function_call" + "function_call_output" ], - "description": "The type of the function tool call. Always `function_call`.", + "description": "The type of the function tool call output. Always `function_call_output`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "name": { - "type": "string", - "description": "The name of the function to run." - }, - "arguments": { - "type": "string", - "description": "A JSON string of the arguments to pass to the function." + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." }, "status": { "type": "string", @@ -26029,7 +26931,9 @@ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ] + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" }, "OpenAI.ItemResourceImageGenToolCall": { "type": "object", @@ -26075,6 +26979,59 @@ "description": "An image generation request made by the model.", "title": "Image generation call" }, + "OpenAI.ItemResourceInputMessage": { + "type": "object", + "required": [ + "type", + "role", + "content", + "id" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "message" + ], + "description": "The type of the message input. Always set to `message`.", + "x-stainless-const": true, + "default": "message" + }, + "role": { + "type": "string", + "enum": [ + "user", + "system", + "developer" + ], + "description": "The role of the message input. One of `user`, `system`, or `developer`." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "content": { + "$ref": "#/components/schemas/OpenAI.InputMessageContentList" + }, + "id": { + "type": "string", + "description": "The unique ID of the message input.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", + "title": "Input message" + }, "OpenAI.ItemResourceLocalShellToolCall": { "type": "object", "required": [ @@ -26282,8 +27239,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -26394,6 +27350,14 @@ }, "description": "The content of the output message." }, + "phase": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + } + ], + "nullable": true + }, "status": { "type": "string", "enum": [ @@ -26412,22 +27376,202 @@ "description": "An output message from the model.", "title": "Output message" }, - "OpenAI.ItemResourceType": { - "anyOf": [ - { - "type": "string" - }, - { + "OpenAI.ItemResourceReasoningItem": { + "type": "object", + "required": [ + "type", + "id", + "summary" + ], + "properties": { + "type": { "type": "string", "enum": [ - "message", - "output_message", - "file_search_call", - "computer_call", + "reasoning" + ], + "description": "The type of the object. Always `reasoning`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique identifier of the reasoning content." + }, + "encrypted_content": { + "type": "string", + "nullable": true + }, + "summary": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.SummaryTextContent" + }, + "description": "Reasoning summary content." + }, + "content": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ReasoningTextContent" + }, + "description": "Reasoning text content." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", + "title": "Reasoning" + }, + "OpenAI.ItemResourceToolSearchCall": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "arguments", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search call item." + }, + "call_id": { + "type": "string", + "nullable": true + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ] + }, + "OpenAI.ItemResourceToolSearchOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "tools", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search output item." + }, + "call_id": { + "type": "string", + "nullable": true + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by tool search." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ] + }, + "OpenAI.ItemResourceType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "message", + "output_message", + "file_search_call", + "computer_call", "computer_call_output", "web_search_call", "function_call", "function_call_output", + "tool_search_call", + "tool_search_output", + "reasoning", + "compaction", "image_generation_call", "code_interpreter_call", "local_shell_call", @@ -26440,6 +27584,8 @@ "mcp_approval_request", "mcp_approval_response", "mcp_call", + "custom_tool_call", + "custom_tool_call_output", "structured_outputs", "oauth_consent_request", "memory_search_call", @@ -26520,6 +27666,115 @@ "description": "The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.", "title": "Web search tool call" }, + "OpenAI.ItemToolSearchCallItemParam": { + "type": "object", + "required": [ + "type", + "arguments" + ], + "properties": { + "id": { + "type": "string", + "nullable": true + }, + "call_id": { + "type": "string", + "nullable": true + }, + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The item type. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" + } + ], + "description": "The arguments supplied to the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + } + ], + "nullable": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ] + }, + "OpenAI.ItemToolSearchOutputItemParam": { + "type": "object", + "required": [ + "type", + "tools" + ], + "properties": { + "id": { + "type": "string", + "nullable": true + }, + "call_id": { + "type": "string", + "nullable": true + }, + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The item type. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by the tool search output." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + } + ], + "nullable": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ] + }, "OpenAI.ItemType": { "anyOf": [ { @@ -26536,6 +27791,8 @@ "web_search_call", "function_call", "function_call_output", + "tool_search_call", + "tool_search_output", "reasoning", "compaction", "image_generation_call", @@ -26778,22 +28035,6 @@ "description": "Represents the use of a local environment to perform shell actions.", "title": "Local Environment" }, - "OpenAI.LocalShellCallOutputStatusEnum": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - "OpenAI.LocalShellCallStatus": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, "OpenAI.LocalShellExecAction": { "type": "object", "required": [ @@ -27061,6 +28302,10 @@ ], "default": "always" }, + "defer_loading": { + "type": "boolean", + "description": "Whether this MCP tool is deferred and discovered via tool search." + }, "project_connection_id": { "type": "string", "description": "The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server." @@ -27134,7 +28379,8 @@ "reasoning_text": "#/components/schemas/OpenAI.MessageContentReasoningTextContent", "refusal": "#/components/schemas/OpenAI.MessageContentRefusalContent", "input_image": "#/components/schemas/OpenAI.MessageContentInputImageContent", - "input_file": "#/components/schemas/OpenAI.MessageContentInputFileContent" + "input_file": "#/components/schemas/OpenAI.MessageContentInputFileContent", + "summary_text": "#/components/schemas/OpenAI.SummaryTextContent" } }, "description": "A content part that makes up an input or output item." @@ -27162,14 +28408,22 @@ "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "allOf": [ @@ -27211,7 +28465,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -27374,6 +28628,14 @@ } ] }, + "OpenAI.MessagePhase": { + "type": "string", + "enum": [ + "commentary", + "final_answer" + ], + "description": "Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`).\nFor models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend\nphase on all assistant messages — dropping it can degrade performance. Not used for user messages." + }, "OpenAI.MessageRole": { "type": "string", "enum": [ @@ -27490,6 +28752,13 @@ } ], "description": "The y-coordinate to move to." + }, + "keys": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } }, "allOf": [ @@ -27500,6 +28769,58 @@ "description": "A mouse move action.", "title": "Move" }, + "OpenAI.NamespaceToolParam": { + "type": "object", + "required": [ + "type", + "name", + "description", + "tools" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "namespace" + ], + "description": "The type of the tool. Always `namespace`.", + "x-stainless-const": true, + "default": "namespace" + }, + "name": { + "type": "string", + "minLength": 1, + "description": "The namespace name used in tool calls (for example, `crm`)." + }, + "description": { + "type": "string", + "minLength": 1, + "description": "A description of the namespace shown to the model." + }, + "tools": { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionToolParam" + }, + { + "$ref": "#/components/schemas/OpenAI.CustomToolParam" + } + ] + }, + "minItems": 1, + "description": "The function/custom tools available inside this namespace." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Tool" + } + ], + "description": "Groups function/custom tools under a shared namespace.", + "title": "Namespace" + }, "OpenAI.OutputContent": { "type": "object", "required": [ @@ -27686,13 +29007,18 @@ "output_message": "#/components/schemas/OpenAI.OutputItemOutputMessage", "file_search_call": "#/components/schemas/OpenAI.OutputItemFileSearchToolCall", "function_call": "#/components/schemas/OpenAI.OutputItemFunctionToolCall", + "function_call_output": "#/components/schemas/OpenAI.OutputItemFunctionToolCallOutput", "web_search_call": "#/components/schemas/OpenAI.OutputItemWebSearchToolCall", "computer_call": "#/components/schemas/OpenAI.OutputItemComputerToolCall", + "computer_call_output": "#/components/schemas/OpenAI.OutputItemComputerToolCallOutput", "reasoning": "#/components/schemas/OpenAI.OutputItemReasoningItem", + "tool_search_call": "#/components/schemas/OpenAI.OutputItemToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.OutputItemToolSearchOutput", "compaction": "#/components/schemas/OpenAI.OutputItemCompactionBody", "image_generation_call": "#/components/schemas/OpenAI.OutputItemImageGenToolCall", "code_interpreter_call": "#/components/schemas/OpenAI.OutputItemCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.OutputItemLocalShellToolCall", + "local_shell_call_output": "#/components/schemas/OpenAI.OutputItemLocalShellToolCallOutput", "shell_call": "#/components/schemas/OpenAI.OutputItemFunctionShellCall", "shell_call_output": "#/components/schemas/OpenAI.OutputItemFunctionShellCallOutput", "apply_patch_call": "#/components/schemas/OpenAI.OutputItemApplyPatchToolCall", @@ -27700,7 +29026,9 @@ "mcp_call": "#/components/schemas/OpenAI.OutputItemMcpToolCall", "mcp_list_tools": "#/components/schemas/OpenAI.OutputItemMcpListTools", "mcp_approval_request": "#/components/schemas/OpenAI.OutputItemMcpApprovalRequest", - "custom_tool_call": "#/components/schemas/OpenAI.OutputItemCustomToolCall" + "mcp_approval_response": "#/components/schemas/OpenAI.OutputItemMcpApprovalResponseResource", + "custom_tool_call": "#/components/schemas/OpenAI.OutputItemCustomToolCallResource", + "custom_tool_call_output": "#/components/schemas/OpenAI.OutputItemCustomToolCallOutputResource" } } }, @@ -27922,7 +29250,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -27946,6 +29273,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -27971,13 +29301,128 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.OutputItemCustomToolCall": { + "OpenAI.OutputItemComputerToolCallOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "output" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer_call_output" + ], + "description": "The type of the computer tool call output. Always `computer_call_output`.", + "x-stainless-const": true, + "default": "computer_call_output" + }, + "id": { + "type": "string", + "description": "The ID of the computer tool call output.", + "readOnly": true + }, + "call_id": { + "type": "string", + "description": "The ID of the computer tool call that produced the output." + }, + "acknowledged_safety_checks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" + }, + "description": "The safety checks reported by the API that have been acknowledged by the\n developer." + }, + "output": { + "$ref": "#/components/schemas/OpenAI.ComputerScreenshotImage" + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the message input. One of `in_progress`, `completed`, or\n `incomplete`. Populated when input items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "The output of a computer tool call.", + "title": "Computer tool call output" + }, + "OpenAI.OutputItemCustomToolCallOutputResource": { + "type": "object", + "required": [ + "type", + "call_id", + "output", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "custom_tool_call_output" + ], + "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the custom tool call output in the OpenAI platform." + }, + "call_id": { + "type": "string", + "description": "The call ID, used to map this custom tool call output to a custom tool call." + }, + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "title": "ResponseCustomToolCallOutputItem" + }, + "OpenAI.OutputItemCustomToolCallResource": { "type": "object", "required": [ "type", "call_id", "name", - "input" + "input", + "status" ], "properties": { "type": { @@ -27996,13 +29441,29 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." }, "input": { "type": "string", - "description": "The input for the custom tool call generated by the model." + "description": "The input for the custom tool call generated by the model." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." } }, "allOf": [ @@ -28010,8 +29471,7 @@ "$ref": "#/components/schemas/OpenAI.OutputItem" } ], - "description": "A call to a custom tool created by the model.", - "title": "Custom tool call" + "title": "ResponseCustomToolCallItem" }, "OpenAI.OutputItemFileSearchToolCall": { "type": "object", @@ -28107,7 +29567,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." @@ -28165,7 +29625,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -28202,6 +29662,7 @@ "OpenAI.OutputItemFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", "name", @@ -28210,7 +29671,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", @@ -28224,6 +29686,10 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, "name": { "type": "string", "description": "The name of the function to run." @@ -28250,6 +29716,64 @@ "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", "title": "Function tool call" }, + "OpenAI.OutputItemFunctionToolCallOutput": { + "type": "object", + "required": [ + "id", + "type", + "call_id", + "output" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true + }, + "type": { + "type": "string", + "enum": [ + "function_call_output" + ], + "description": "The type of the function tool call output. Always `function_call_output`.", + "x-stainless-const": true + }, + "call_id": { + "type": "string", + "description": "The unique ID of the function tool call generated by the model." + }, + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" + }, "OpenAI.OutputItemImageGenToolCall": { "type": "object", "required": [ @@ -28341,6 +29865,48 @@ "description": "A tool call to run a command on the local shell.", "title": "Local shell call" }, + "OpenAI.OutputItemLocalShellToolCallOutput": { + "type": "object", + "required": [ + "type", + "id", + "output" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "local_shell_call_output" + ], + "description": "The type of the local shell tool call output. Always `local_shell_call_output`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the local shell tool call generated by the model." + }, + "output": { + "type": "string", + "description": "A JSON string of the output of the local shell tool call." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "nullable": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "The output of a local shell tool call.", + "title": "Local shell call output" + }, "OpenAI.OutputItemMcpApprovalRequest": { "type": "object", "required": [ @@ -28384,6 +29950,48 @@ "description": "A request for human approval of a tool invocation.", "title": "MCP approval request" }, + "OpenAI.OutputItemMcpApprovalResponseResource": { + "type": "object", + "required": [ + "type", + "id", + "approval_request_id", + "approve" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "mcp_approval_response" + ], + "description": "The type of the item. Always `mcp_approval_response`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the approval response" + }, + "approval_request_id": { + "type": "string", + "description": "The ID of the approval request being answered." + }, + "approve": { + "type": "boolean", + "description": "Whether the request was approved." + }, + "reason": { + "type": "string", + "nullable": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "A response to an MCP approval request.", + "title": "MCP approval response" + }, "OpenAI.OutputItemMcpListTools": { "type": "object", "required": [ @@ -28417,8 +30025,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -28529,6 +30136,14 @@ }, "description": "The content of the output message." }, + "phase": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + } + ], + "nullable": true + }, "status": { "type": "string", "enum": [ @@ -28547,61 +30162,181 @@ "description": "An output message from the model.", "title": "Output message" }, - "OpenAI.OutputItemReasoningItem": { + "OpenAI.OutputItemReasoningItem": { + "type": "object", + "required": [ + "type", + "id", + "summary" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "reasoning" + ], + "description": "The type of the object. Always `reasoning`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique identifier of the reasoning content." + }, + "encrypted_content": { + "type": "string", + "nullable": true + }, + "summary": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.SummaryTextContent" + }, + "description": "Reasoning summary content." + }, + "content": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ReasoningTextContent" + }, + "description": "Reasoning text content." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", + "title": "Reasoning" + }, + "OpenAI.OutputItemToolSearchCall": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "arguments", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search call item." + }, + "call_id": { + "type": "string", + "nullable": true + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ] + }, + "OpenAI.OutputItemToolSearchOutput": { "type": "object", "required": [ "type", "id", - "summary" + "call_id", + "execution", + "tools", + "status" ], "properties": { "type": { "type": "string", "enum": [ - "reasoning" + "tool_search_output" ], - "description": "The type of the object. Always `reasoning`.", - "x-stainless-const": true + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" }, "id": { "type": "string", - "description": "The unique identifier of the reasoning content." + "description": "The unique ID of the tool search output item." }, - "encrypted_content": { + "call_id": { "type": "string", "nullable": true }, - "summary": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.SummaryTextContent" - }, - "description": "Reasoning summary content." + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." }, - "content": { + "tools": { "type": "array", "items": { - "$ref": "#/components/schemas/OpenAI.ReasoningTextContent" + "$ref": "#/components/schemas/OpenAI.Tool" }, - "description": "Reasoning text content." + "description": "The loaded tool definitions returned by tool search." }, "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." } }, "allOf": [ { "$ref": "#/components/schemas/OpenAI.OutputItem" } - ], - "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", - "title": "Reasoning" + ] }, "OpenAI.OutputItemType": { "anyOf": [ @@ -28614,13 +30349,18 @@ "output_message", "file_search_call", "function_call", + "function_call_output", "web_search_call", "computer_call", + "computer_call_output", "reasoning", + "tool_search_call", + "tool_search_output", "compaction", "image_generation_call", "code_interpreter_call", "local_shell_call", + "local_shell_call_output", "shell_call", "shell_call_output", "apply_patch_call", @@ -28628,7 +30368,9 @@ "mcp_call", "mcp_list_tools", "mcp_approval_request", + "mcp_approval_response", "custom_tool_call", + "custom_tool_call_output", "structured_outputs", "oauth_consent_request", "memory_search_call", @@ -28840,6 +30582,13 @@ }, "description": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts)." }, + "OpenAI.PromptCacheRetentionEnum": { + "type": "string", + "enum": [ + "in_memory", + "24h" + ] + }, "OpenAI.RankerVersionType": { "type": "string", "enum": [ @@ -28876,6 +30625,123 @@ } } }, + "OpenAI.RealtimeMCPError": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/OpenAI.RealtimeMcpErrorType" + } + }, + "discriminator": { + "propertyName": "type", + "mapping": { + "protocol_error": "#/components/schemas/OpenAI.RealtimeMCPProtocolError", + "tool_execution_error": "#/components/schemas/OpenAI.RealtimeMCPToolExecutionError", + "http_error": "#/components/schemas/OpenAI.RealtimeMCPHTTPError" + } + } + }, + "OpenAI.RealtimeMCPHTTPError": { + "type": "object", + "required": [ + "type", + "code", + "message" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "http_error" + ], + "x-stainless-const": true + }, + "code": { + "$ref": "#/components/schemas/OpenAI.integer" + }, + "message": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + } + ], + "title": "Realtime MCP HTTP error" + }, + "OpenAI.RealtimeMCPProtocolError": { + "type": "object", + "required": [ + "type", + "code", + "message" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "protocol_error" + ], + "x-stainless-const": true + }, + "code": { + "$ref": "#/components/schemas/OpenAI.integer" + }, + "message": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + } + ], + "title": "Realtime MCP protocol error" + }, + "OpenAI.RealtimeMCPToolExecutionError": { + "type": "object", + "required": [ + "type", + "message" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_execution_error" + ], + "x-stainless-const": true + }, + "message": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + } + ], + "title": "Realtime MCP tool execution error" + }, + "OpenAI.RealtimeMcpErrorType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "protocol_error", + "tool_execution_error", + "http_error" + ] + } + ] + }, "OpenAI.Reasoning": { "type": "object", "properties": { @@ -29000,7 +30866,8 @@ }, "safety_identifier": { "type": "string", - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + "maxLength": 64, + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." }, "prompt_cache_key": { "type": "string", @@ -29012,7 +30879,7 @@ "prompt_cache_retention": { "type": "string", "enum": [ - "in-memory", + "in_memory", "24h" ], "nullable": true @@ -29038,15 +30905,6 @@ "type": "boolean", "nullable": true }, - "max_output_tokens": { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true - }, "max_tool_calls": { "type": "integer", "allOf": [ @@ -29178,6 +31036,15 @@ ], "nullable": true }, + "max_output_tokens": { + "type": "integer", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + } + ], + "nullable": true + }, "agent_reference": { "type": "object", "allOf": [ @@ -29221,6 +31088,11 @@ "description": "A chunk of Base64 encoded response audio bytes." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial audio response.", "x-oaiMeta": { "name": "response.audio.delta", @@ -29252,6 +31124,11 @@ "description": "The sequence number of the delta." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the audio response is complete.", "x-oaiMeta": { "name": "response.audio.done", @@ -29288,6 +31165,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial transcript of audio.", "x-oaiMeta": { "name": "response.audio.transcript.delta", @@ -29319,6 +31201,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the full audio transcript is completed.", "x-oaiMeta": { "name": "response.audio.transcript.done", @@ -29369,6 +31256,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a partial code snippet is streamed by the code interpreter.", "x-oaiMeta": { "name": "response.code_interpreter_call_code.delta", @@ -29419,6 +31311,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the code snippet is finalized by the code interpreter.", "x-oaiMeta": { "name": "response.code_interpreter_call_code.done", @@ -29464,6 +31361,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the code interpreter call is completed.", "x-oaiMeta": { "name": "response.code_interpreter_call.completed", @@ -29509,6 +31411,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a code interpreter call is in progress.", "x-oaiMeta": { "name": "response.code_interpreter_call.in_progress", @@ -29554,6 +31461,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the code interpreter is actively interpreting the code snippet.", "x-oaiMeta": { "name": "response.code_interpreter_call.interpreting", @@ -29594,6 +31506,11 @@ "description": "The sequence number for this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the model response is complete.", "x-oaiMeta": { "name": "response.completed", @@ -29657,6 +31574,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a new content part is added.", "x-oaiMeta": { "name": "response.content_part.added", @@ -29720,6 +31642,11 @@ "description": "The content part that is done." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a content part is done.", "x-oaiMeta": { "name": "response.content_part.done", @@ -29760,6 +31687,11 @@ "description": "The sequence number for this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "An event that is emitted when a response is created.", "x-oaiMeta": { "name": "response.created", @@ -29810,6 +31742,11 @@ "description": "The incremental input data (delta) for the custom tool call." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Event representing a delta (partial update) to the input of a custom tool call.", "title": "ResponseCustomToolCallInputDelta", "x-oaiMeta": { @@ -29861,6 +31798,11 @@ "description": "The complete input data for the custom tool call." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Event indicating that input for a custom tool call is complete.", "title": "ResponseCustomToolCallInputDone", "x-oaiMeta": { @@ -29949,6 +31891,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an error occurs.", "x-oaiMeta": { "name": "error", @@ -29989,6 +31936,11 @@ "description": "The response that failed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "An event that is emitted when a response fails.", "x-oaiMeta": { "name": "response.failed", @@ -30034,6 +31986,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a file search call is completed (results found).", "x-oaiMeta": { "name": "response.file_search_call.completed", @@ -30079,6 +32036,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a file search call is initiated.", "x-oaiMeta": { "name": "response.file_search_call.in_progress", @@ -30124,6 +32086,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a file search is currently searching.", "x-oaiMeta": { "name": "response.file_search_call.searching", @@ -30270,6 +32237,11 @@ "description": "The function-call arguments delta that is added." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial function-call arguments delta.", "x-oaiMeta": { "name": "response.function_call_arguments.delta", @@ -30323,7 +32295,12 @@ "type": "string", "description": "The function-call arguments." } - }, + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when function-call arguments are finalized.", "x-oaiMeta": { "name": "response.function_call_arguments.done", @@ -30369,6 +32346,11 @@ "description": "The unique identifier of the image generation item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an image generation tool call has completed and the final image is available.", "title": "ResponseImageGenCallCompletedEvent", "x-oaiMeta": { @@ -30415,6 +32397,11 @@ "description": "The sequence number of the image generation item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an image generation tool call is actively generating an image (intermediate state).", "title": "ResponseImageGenCallGeneratingEvent", "x-oaiMeta": { @@ -30461,6 +32448,11 @@ "description": "The sequence number of the image generation item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an image generation tool call is in progress.", "title": "ResponseImageGenCallInProgressEvent", "x-oaiMeta": { @@ -30521,6 +32513,11 @@ "description": "Base64-encoded partial image data, suitable for rendering as an image." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a partial image is available during image generation streaming.", "title": "ResponseImageGenCallPartialImageEvent", "x-oaiMeta": { @@ -30562,6 +32559,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the response is in progress.", "x-oaiMeta": { "name": "response.in_progress", @@ -30614,6 +32616,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "An event that is emitted when a response finishes as incomplete.", "x-oaiMeta": { "name": "response.incomplete", @@ -30645,7 +32652,7 @@ "items": { "$ref": "#/components/schemas/OpenAI.ResponseLogProbTopLogprobs" }, - "description": "The log probability of the top 20 most likely tokens." + "description": "The log probabilities of up to 20 of the most likely tokens." } }, "description": "A logprob is the logarithmic probability that the model assigns to producing\na particular token at a given position in the sequence. Less-negative (higher)\nlogprob values indicate greater model confidence in that token choice." @@ -30704,6 +32711,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a delta (partial update) to the arguments of an MCP tool call.", "title": "ResponseMCPCallArgumentsDeltaEvent", "x-oaiMeta": { @@ -30755,6 +32767,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the arguments for an MCP tool call are finalized.", "title": "ResponseMCPCallArgumentsDoneEvent", "x-oaiMeta": { @@ -30801,6 +32818,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an MCP tool call has completed successfully.", "title": "ResponseMCPCallCompletedEvent", "x-oaiMeta": { @@ -30847,6 +32869,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an MCP tool call has failed.", "title": "ResponseMCPCallFailedEvent", "x-oaiMeta": { @@ -30893,6 +32920,11 @@ "description": "The unique identifier of the MCP tool call item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an MCP tool call is in progress.", "title": "ResponseMCPCallInProgressEvent", "x-oaiMeta": { @@ -30939,6 +32971,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the list of available MCP tools has been successfully retrieved.", "title": "ResponseMCPListToolsCompletedEvent", "x-oaiMeta": { @@ -30985,6 +33022,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the attempt to list available MCP tools has failed.", "title": "ResponseMCPListToolsFailedEvent", "x-oaiMeta": { @@ -31031,6 +33073,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the system is in the process of retrieving the list of available MCP tools.", "title": "ResponseMCPListToolsInProgressEvent", "x-oaiMeta": { @@ -31081,6 +33128,11 @@ "description": "The output item that was added." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a new output item is added.", "x-oaiMeta": { "name": "response.output_item.added", @@ -31130,6 +33182,11 @@ "description": "The output item that was marked done." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an output item is marked done.", "x-oaiMeta": { "name": "response.output_item.done", @@ -31202,6 +33259,11 @@ "description": "The annotation object being added. (See annotation schema for details.)" } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an annotation is added to output text content.", "title": "ResponseOutputTextAnnotationAddedEvent", "x-oaiMeta": { @@ -31266,6 +33328,11 @@ "description": "The sequence number for this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a response is queued and waiting to be processed.", "title": "ResponseQueuedEvent", "x-oaiMeta": { @@ -31330,6 +33397,11 @@ "description": "The summary part that was added." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a new reasoning summary part is added.", "x-oaiMeta": { "name": "response.reasoning_summary_part.added", @@ -31412,6 +33484,11 @@ "description": "The completed summary part." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a reasoning summary part is completed.", "x-oaiMeta": { "name": "response.reasoning_summary_part.done", @@ -31490,6 +33567,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a delta is added to a reasoning summary text.", "x-oaiMeta": { "name": "response.reasoning_summary_text.delta", @@ -31549,6 +33631,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a reasoning summary text is completed.", "x-oaiMeta": { "name": "response.reasoning_summary_text.done", @@ -31608,6 +33695,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a delta is added to a reasoning text.", "x-oaiMeta": { "name": "response.reasoning_text.delta", @@ -31667,6 +33759,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a reasoning text is completed.", "x-oaiMeta": { "name": "response.reasoning_text.done", @@ -31726,6 +33823,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial refusal text.", "x-oaiMeta": { "name": "response.refusal.delta", @@ -31785,6 +33887,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when refusal text is finalized.", "x-oaiMeta": { "name": "response.refusal.done", @@ -31792,6 +33899,140 @@ "example": "{\n \"type\": \"response.refusal.done\",\n \"item_id\": \"item-abc\",\n \"output_index\": 1,\n \"content_index\": 2,\n \"refusal\": \"final refusal text\",\n \"sequence_number\": 1\n}\n" } }, + "OpenAI.ResponseStreamEvent": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEventType" + } + }, + "discriminator": { + "propertyName": "type", + "mapping": { + "response.audio.transcript.delta": "#/components/schemas/OpenAI.ResponseAudioTranscriptDeltaEvent", + "response.code_interpreter_call_code.delta": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent", + "response.code_interpreter_call.in_progress": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallInProgressEvent", + "response.code_interpreter_call.interpreting": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallInterpretingEvent", + "response.content_part.added": "#/components/schemas/OpenAI.ResponseContentPartAddedEvent", + "response.created": "#/components/schemas/OpenAI.ResponseCreatedEvent", + "error": "#/components/schemas/OpenAI.ResponseErrorEvent", + "response.file_search_call.in_progress": "#/components/schemas/OpenAI.ResponseFileSearchCallInProgressEvent", + "response.file_search_call.searching": "#/components/schemas/OpenAI.ResponseFileSearchCallSearchingEvent", + "response.function_call_arguments.delta": "#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDeltaEvent", + "response.in_progress": "#/components/schemas/OpenAI.ResponseInProgressEvent", + "response.failed": "#/components/schemas/OpenAI.ResponseFailedEvent", + "response.incomplete": "#/components/schemas/OpenAI.ResponseIncompleteEvent", + "response.output_item.added": "#/components/schemas/OpenAI.ResponseOutputItemAddedEvent", + "response.reasoning_summary_part.added": "#/components/schemas/OpenAI.ResponseReasoningSummaryPartAddedEvent", + "response.reasoning_summary_text.delta": "#/components/schemas/OpenAI.ResponseReasoningSummaryTextDeltaEvent", + "response.reasoning_text.delta": "#/components/schemas/OpenAI.ResponseReasoningTextDeltaEvent", + "response.refusal.delta": "#/components/schemas/OpenAI.ResponseRefusalDeltaEvent", + "response.output_text.delta": "#/components/schemas/OpenAI.ResponseTextDeltaEvent", + "response.web_search_call.in_progress": "#/components/schemas/OpenAI.ResponseWebSearchCallInProgressEvent", + "response.web_search_call.searching": "#/components/schemas/OpenAI.ResponseWebSearchCallSearchingEvent", + "response.image_generation_call.generating": "#/components/schemas/OpenAI.ResponseImageGenCallGeneratingEvent", + "response.image_generation_call.in_progress": "#/components/schemas/OpenAI.ResponseImageGenCallInProgressEvent", + "response.image_generation_call.partial_image": "#/components/schemas/OpenAI.ResponseImageGenCallPartialImageEvent", + "response.mcp_call_arguments.delta": "#/components/schemas/OpenAI.ResponseMCPCallArgumentsDeltaEvent", + "response.mcp_call.failed": "#/components/schemas/OpenAI.ResponseMCPCallFailedEvent", + "response.mcp_call.in_progress": "#/components/schemas/OpenAI.ResponseMCPCallInProgressEvent", + "response.mcp_list_tools.failed": "#/components/schemas/OpenAI.ResponseMCPListToolsFailedEvent", + "response.mcp_list_tools.in_progress": "#/components/schemas/OpenAI.ResponseMCPListToolsInProgressEvent", + "response.output_text.annotation.added": "#/components/schemas/OpenAI.ResponseOutputTextAnnotationAddedEvent", + "response.queued": "#/components/schemas/OpenAI.ResponseQueuedEvent", + "response.custom_tool_call_input.delta": "#/components/schemas/OpenAI.ResponseCustomToolCallInputDeltaEvent", + "response.audio.done": "#/components/schemas/OpenAI.ResponseAudioDoneEvent", + "response.audio.transcript.done": "#/components/schemas/OpenAI.ResponseAudioTranscriptDoneEvent", + "response.code_interpreter_call_code.done": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDoneEvent", + "response.code_interpreter_call.completed": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCompletedEvent", + "response.completed": "#/components/schemas/OpenAI.ResponseCompletedEvent", + "response.content_part.done": "#/components/schemas/OpenAI.ResponseContentPartDoneEvent", + "response.file_search_call.completed": "#/components/schemas/OpenAI.ResponseFileSearchCallCompletedEvent", + "response.function_call_arguments.done": "#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDoneEvent", + "response.output_item.done": "#/components/schemas/OpenAI.ResponseOutputItemDoneEvent", + "response.reasoning_summary_part.done": "#/components/schemas/OpenAI.ResponseReasoningSummaryPartDoneEvent", + "response.reasoning_summary_text.done": "#/components/schemas/OpenAI.ResponseReasoningSummaryTextDoneEvent", + "response.reasoning_text.done": "#/components/schemas/OpenAI.ResponseReasoningTextDoneEvent", + "response.refusal.done": "#/components/schemas/OpenAI.ResponseRefusalDoneEvent", + "response.output_text.done": "#/components/schemas/OpenAI.ResponseTextDoneEvent", + "response.web_search_call.completed": "#/components/schemas/OpenAI.ResponseWebSearchCallCompletedEvent", + "response.image_generation_call.completed": "#/components/schemas/OpenAI.ResponseImageGenCallCompletedEvent", + "response.mcp_call_arguments.done": "#/components/schemas/OpenAI.ResponseMCPCallArgumentsDoneEvent", + "response.mcp_call.completed": "#/components/schemas/OpenAI.ResponseMCPCallCompletedEvent", + "response.mcp_list_tools.completed": "#/components/schemas/OpenAI.ResponseMCPListToolsCompletedEvent", + "response.custom_tool_call_input.done": "#/components/schemas/OpenAI.ResponseCustomToolCallInputDoneEvent", + "response.audio.delta": "#/components/schemas/OpenAI.ResponseAudioDeltaEvent" + } + } + }, + "OpenAI.ResponseStreamEventType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "response.audio.delta", + "response.audio.done", + "response.audio.transcript.delta", + "response.audio.transcript.done", + "response.code_interpreter_call_code.delta", + "response.code_interpreter_call_code.done", + "response.code_interpreter_call.completed", + "response.code_interpreter_call.in_progress", + "response.code_interpreter_call.interpreting", + "response.completed", + "response.content_part.added", + "response.content_part.done", + "response.created", + "error", + "response.file_search_call.completed", + "response.file_search_call.in_progress", + "response.file_search_call.searching", + "response.function_call_arguments.delta", + "response.function_call_arguments.done", + "response.in_progress", + "response.failed", + "response.incomplete", + "response.output_item.added", + "response.output_item.done", + "response.reasoning_summary_part.added", + "response.reasoning_summary_part.done", + "response.reasoning_summary_text.delta", + "response.reasoning_summary_text.done", + "response.reasoning_text.delta", + "response.reasoning_text.done", + "response.refusal.delta", + "response.refusal.done", + "response.output_text.delta", + "response.output_text.done", + "response.web_search_call.completed", + "response.web_search_call.in_progress", + "response.web_search_call.searching", + "response.image_generation_call.completed", + "response.image_generation_call.generating", + "response.image_generation_call.in_progress", + "response.image_generation_call.partial_image", + "response.mcp_call_arguments.delta", + "response.mcp_call_arguments.done", + "response.mcp_call.completed", + "response.mcp_call.failed", + "response.mcp_call.in_progress", + "response.mcp_list_tools.completed", + "response.mcp_list_tools.failed", + "response.mcp_list_tools.in_progress", + "response.output_text.annotation.added", + "response.queued", + "response.custom_tool_call_input.delta", + "response.custom_tool_call_input.done" + ] + } + ] + }, "OpenAI.ResponseStreamOptions": { "type": "object", "properties": { @@ -31862,6 +34103,11 @@ "description": "The log probabilities of the tokens in the delta." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is an additional text delta.", "x-oaiMeta": { "name": "response.output_text.delta", @@ -31929,6 +34175,11 @@ "description": "The log probabilities of the tokens in the delta." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when text content is finalized.", "x-oaiMeta": { "name": "response.output_text.done", @@ -32061,6 +34312,11 @@ "description": "The sequence number of the web search call being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a web search call is completed.", "x-oaiMeta": { "name": "response.web_search_call.completed", @@ -32106,6 +34362,11 @@ "description": "The sequence number of the web search call being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a web search call is initiated.", "x-oaiMeta": { "name": "response.web_search_call.in_progress", @@ -32151,6 +34412,11 @@ "description": "The sequence number of the web search call being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a web search call is executing.", "x-oaiMeta": { "name": "response.web_search_call.searching", @@ -32232,6 +34498,13 @@ } ], "description": "The vertical scroll distance." + }, + "keys": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } }, "allOf": [ @@ -32242,6 +34515,13 @@ "description": "A scroll action.", "title": "Scroll" }, + "OpenAI.SearchContentType": { + "type": "string", + "enum": [ + "text", + "image" + ] + }, "OpenAI.SearchContextSize": { "type": "string", "enum": [ @@ -32262,6 +34542,15 @@ "description": "Specifies the processing type used for serving the request.\n- If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n- If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n- If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier.\n- When not set, the default behavior is 'auto'.\nWhen the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.", "nullable": true }, + "OpenAI.ServiceTierEnum": { + "type": "string", + "enum": [ + "auto", + "default", + "flex", + "priority" + ] + }, "OpenAI.SkillReferenceParam": { "type": "object", "required": [ @@ -32555,7 +34844,10 @@ "shell": "#/components/schemas/OpenAI.FunctionShellToolParam", "custom": "#/components/schemas/OpenAI.CustomToolParam", "web_search_preview": "#/components/schemas/OpenAI.WebSearchPreviewTool", - "apply_patch": "#/components/schemas/OpenAI.ApplyPatchToolParam" + "apply_patch": "#/components/schemas/OpenAI.ApplyPatchToolParam", + "computer": "#/components/schemas/OpenAI.ComputerTool", + "namespace": "#/components/schemas/OpenAI.NamespaceToolParam", + "tool_search": "#/components/schemas/OpenAI.ToolSearchToolParam" } }, "description": "A tool that can be used to generate a response." @@ -32621,6 +34913,46 @@ ], "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." }, + "OpenAI.ToolChoiceComputer": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer" + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" + } + ], + "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." + }, + "OpenAI.ToolChoiceComputerUse": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer_use" + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" + } + ], + "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." + }, "OpenAI.ToolChoiceComputerUsePreview": { "type": "object", "required": [ @@ -32803,7 +35135,9 @@ "computer_use_preview": "#/components/schemas/OpenAI.ToolChoiceComputerUsePreview", "web_search_preview_2025_03_11": "#/components/schemas/OpenAI.ToolChoiceWebSearchPreview20250311", "image_generation": "#/components/schemas/OpenAI.ToolChoiceImageGeneration", - "code_interpreter": "#/components/schemas/OpenAI.ToolChoiceCodeInterpreter" + "code_interpreter": "#/components/schemas/OpenAI.ToolChoiceCodeInterpreter", + "computer": "#/components/schemas/OpenAI.ToolChoiceComputer", + "computer_use": "#/components/schemas/OpenAI.ToolChoiceComputerUse" } }, "description": "How the model should select which tool (or tools) to use when generating\na response. See the `tools` parameter to see how to specify which tools\nthe model can call." @@ -32827,7 +35161,9 @@ "computer_use_preview", "web_search_preview_2025_03_11", "image_generation", - "code_interpreter" + "code_interpreter", + "computer", + "computer_use" ] } ] @@ -32872,6 +35208,58 @@ ], "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." }, + "OpenAI.ToolSearchExecutionType": { + "type": "string", + "enum": [ + "server", + "client" + ] + }, + "OpenAI.ToolSearchToolParam": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search" + ], + "description": "The type of the tool. Always `tool_search`.", + "x-stainless-const": true, + "default": "tool_search" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search is executed by the server or by the client." + }, + "description": { + "type": "string", + "nullable": true + }, + "parameters": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" + } + ], + "nullable": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Tool" + } + ], + "description": "Hosted or BYOT tool search configuration for deferred tools.", + "title": "Tool search tool" + }, "OpenAI.ToolType": { "anyOf": [ { @@ -32882,6 +35270,7 @@ "enum": [ "function", "file_search", + "computer", "computer_use_preview", "web_search", "mcp", @@ -32890,6 +35279,8 @@ "local_shell", "shell", "custom", + "namespace", + "tool_search", "web_search_preview", "apply_patch", "a2a_preview", @@ -33198,7 +35589,8 @@ "x-stainless-const": true }, "url": { - "type": "string" + "type": "string", + "format": "uri" } } }, @@ -33268,6 +35660,12 @@ } ], "description": "High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default." + }, + "search_content_types": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.SearchContentType" + } } }, "allOf": [ diff --git a/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.json b/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.json index 09ce3aeba9aa..365456e9ed92 100644 --- a/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.json +++ b/specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.json @@ -7815,7 +7815,8 @@ }, "safety_identifier": { "type": "string", - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + "maxLength": 64, + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." }, "prompt_cache_key": { "type": "string", @@ -7827,7 +7828,7 @@ "prompt_cache_retention": { "type": "string", "enum": [ - "in-memory", + "in_memory", "24h" ], "nullable": true @@ -7853,15 +7854,6 @@ "type": "boolean", "nullable": true }, - "max_output_tokens": { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true - }, "max_tool_calls": { "type": "integer", "allOf": [ @@ -7952,6 +7944,15 @@ "nullable": true, "description": "Context management configuration for this request." }, + "max_output_tokens": { + "type": "integer", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + } + ], + "nullable": true + }, "agent": { "allOf": [ { @@ -8027,7 +8028,8 @@ }, "safety_identifier": { "type": "string", - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + "maxLength": 64, + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." }, "prompt_cache_key": { "type": "string", @@ -8039,7 +8041,7 @@ "prompt_cache_retention": { "type": "string", "enum": [ - "in-memory", + "in_memory", "24h" ], "nullable": true @@ -8065,15 +8067,6 @@ "type": "boolean", "nullable": true }, - "max_output_tokens": { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true - }, "max_tool_calls": { "type": "integer", "allOf": [ @@ -8164,6 +8157,15 @@ "nullable": true, "description": "Context management configuration for this request." }, + "max_output_tokens": { + "type": "integer", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + } + ], + "nullable": true + }, "agent": { "allOf": [ { @@ -9281,6 +9283,48 @@ "Schedules" ] } + }, + "/{jobId}": { + "delete": { + "operationId": "deleteJob", + "description": "Delete a job. Returns 204 No Content.", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "description": "The ID of the job to delete.", + "schema": { + "type": "string" + } + }, + { + "name": "api-version", + "in": "query", + "required": true, + "description": "The API version to use for this operation.", + "schema": { + "type": "string" + }, + "explode": false + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful." + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + } + } + } } }, "security": [ @@ -12619,7 +12663,9 @@ }, "discriminator": { "propertyName": "type", - "mapping": {} + "mapping": { + "azure_ai_source": "#/components/schemas/AzureAIDataSourceConfig" + } }, "description": "Base class for run data sources with discriminator support." }, @@ -15523,7 +15569,8 @@ "red_team": "#/components/schemas/RedTeamItemGenerationParams", "red_team_seed_prompts": "#/components/schemas/RedTeamSeedPromptsItemGenerationParams", "red_team_taxonomy": "#/components/schemas/RedTeamTaxonomyItemGenerationParams", - "response_retrieval": "#/components/schemas/ResponseRetrievalItemGenerationParams" + "response_retrieval": "#/components/schemas/ResponseRetrievalItemGenerationParams", + "synthetic_data_gen_preview": "#/components/schemas/SyntheticDataGenerationPreviewItemGenerationParams" } }, "description": "Represents the set of parameters used to control item generation operations." @@ -17088,6 +17135,12 @@ "OpenAI.ChatModel": { "type": "string", "enum": [ + "gpt-5.4", + "gpt-5.4-mini", + "gpt-5.4-nano", + "gpt-5.4-mini-2026-03-17", + "gpt-5.4-nano-2026-03-17", + "gpt-5.3-chat-latest", "gpt-5.2", "gpt-5.2-2025-12-11", "gpt-5.2-chat-latest", @@ -17213,6 +17266,13 @@ } ], "description": "The y-coordinate where the click occurred." + }, + "keys": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } }, "allOf": [ @@ -17382,6 +17442,26 @@ "instructions": { "type": "string", "nullable": true + }, + "prompt_cache_key": { + "type": "string", + "nullable": true + }, + "prompt_cache_retention": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.PromptCacheRetentionEnum" + } + ], + "nullable": true + }, + "service_tier": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ServiceTierEnum" + } + ], + "nullable": true } } }, @@ -17401,7 +17481,9 @@ "gt", "gte", "lt", - "lte" + "lte", + "in", + "nin" ], "description": "Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.\n - `eq`: equals\n - `ne`: not equal\n - `gt`: greater than\n - `gte`: greater than or equal\n - `lt`: less than\n - `lte`: less than or equal\n - `in`: in\n - `nin`: not in", "default": "eq" @@ -17503,6 +17585,14 @@ } } }, + "OpenAI.ComputerActionList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerAction" + }, + "description": "Flattened batched actions for `computer_use`. Each action includes an\n`type` discriminator and action-specific fields.", + "title": "Computer Action List" + }, "OpenAI.ComputerActionType": { "anyOf": [ { @@ -17560,7 +17650,8 @@ "required": [ "type", "image_url", - "file_id" + "file_id", + "detail" ], "properties": { "type": { @@ -17580,6 +17671,14 @@ "file_id": { "type": "string", "nullable": true + }, + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ImageDetail" + } + ], + "description": "The detail level of the screenshot image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -17617,6 +17716,30 @@ }, "description": "A computer screenshot image used with the computer use tool." }, + "OpenAI.ComputerTool": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer" + ], + "description": "The type of the computer tool. Always `computer`.", + "x-stainless-const": true, + "default": "computer" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Tool" + } + ], + "description": "A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).", + "title": "Computer" + }, "OpenAI.ComputerUsePreviewTool": { "type": "object", "required": [ @@ -17806,14 +17929,6 @@ }, "minItems": 1, "description": "A list of allowed domains when type is `allowlist`." - }, - "domain_secrets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.ContainerNetworkPolicyDomainSecretParam" - }, - "minItems": 1, - "description": "Optional domain-scoped secrets for allowlisted domains." } }, "allOf": [ @@ -17844,32 +17959,6 @@ } ] }, - "OpenAI.ContainerNetworkPolicyDomainSecretParam": { - "type": "object", - "required": [ - "domain", - "name", - "value" - ], - "properties": { - "domain": { - "type": "string", - "minLength": 1, - "description": "The domain associated with the secret." - }, - "name": { - "type": "string", - "minLength": 1, - "description": "The name of the secret to inject for the domain." - }, - "value": { - "type": "string", - "minLength": 1, - "maxLength": 10485760, - "description": "The secret value to inject for the domain." - } - } - }, "OpenAI.ContainerNetworkPolicyParam": { "type": "object", "required": [ @@ -17998,14 +18087,17 @@ "propertyName": "type", "mapping": { "message": "#/components/schemas/OpenAI.ConversationItemMessage", - "function_call": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallResource", - "function_call_output": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutputResource", + "function_call": "#/components/schemas/OpenAI.ConversationItemFunctionToolCall", + "function_call_output": "#/components/schemas/OpenAI.ConversationItemFunctionToolCallOutput", "file_search_call": "#/components/schemas/OpenAI.ConversationItemFileSearchToolCall", "web_search_call": "#/components/schemas/OpenAI.ConversationItemWebSearchToolCall", "image_generation_call": "#/components/schemas/OpenAI.ConversationItemImageGenToolCall", "computer_call": "#/components/schemas/OpenAI.ConversationItemComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ConversationItemComputerToolCallOutputResource", + "computer_call_output": "#/components/schemas/OpenAI.ConversationItemComputerToolCallOutput", + "tool_search_call": "#/components/schemas/OpenAI.ConversationItemToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.ConversationItemToolSearchOutput", "reasoning": "#/components/schemas/OpenAI.ConversationItemReasoningItem", + "compaction": "#/components/schemas/OpenAI.ConversationItemCompactionBody", "code_interpreter_call": "#/components/schemas/OpenAI.ConversationItemCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.ConversationItemLocalShellToolCall", "local_shell_call_output": "#/components/schemas/OpenAI.ConversationItemLocalShellToolCallOutput", @@ -18017,8 +18109,8 @@ "mcp_approval_request": "#/components/schemas/OpenAI.ConversationItemMcpApprovalRequest", "mcp_approval_response": "#/components/schemas/OpenAI.ConversationItemMcpApprovalResponseResource", "mcp_call": "#/components/schemas/OpenAI.ConversationItemMcpToolCall", - "custom_tool_call": "#/components/schemas/OpenAI.ConversationItemCustomToolCall", - "custom_tool_call_output": "#/components/schemas/OpenAI.ConversationItemCustomToolCallOutput" + "custom_tool_call": "#/components/schemas/OpenAI.ConversationItemCustomToolCallResource", + "custom_tool_call_output": "#/components/schemas/OpenAI.ConversationItemCustomToolCallOutputResource" } }, "description": "A single item within a conversation. The set of possible types are the same as the `output` type of a [Response object](/docs/api-reference/responses/object#responses/object-output).", @@ -18198,13 +18290,50 @@ "description": "A tool call to run code.", "title": "Code interpreter tool call" }, + "OpenAI.ConversationItemCompactionBody": { + "type": "object", + "required": [ + "type", + "id", + "encrypted_content" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "compaction" + ], + "description": "The type of the item. Always `compaction`.", + "x-stainless-const": true, + "default": "compaction" + }, + "id": { + "type": "string", + "description": "The unique ID of the compaction item." + }, + "encrypted_content": { + "type": "string", + "description": "The encrypted content that was produced by compaction." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ], + "description": "A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact).", + "title": "Compaction item" + }, "OpenAI.ConversationItemComputerToolCall": { "type": "object", "required": [ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -18228,6 +18357,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -18253,10 +18385,11 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ConversationItemComputerToolCallOutputResource": { + "OpenAI.ConversationItemComputerToolCallOutput": { "type": "object", "required": [ "type", + "id", "call_id", "output" ], @@ -18272,7 +18405,8 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output." + "description": "The ID of the computer tool call output.", + "readOnly": true }, "call_id": { "type": "string", @@ -18302,40 +18436,60 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ] + ], + "description": "The output of a computer tool call.", + "title": "Computer tool call output" }, - "OpenAI.ConversationItemCustomToolCall": { + "OpenAI.ConversationItemCustomToolCallOutputResource": { "type": "object", "required": [ "type", "call_id", - "name", - "input" + "output", + "status" ], "properties": { "type": { "type": "string", "enum": [ - "custom_tool_call" + "custom_tool_call_output" ], - "description": "The type of the custom tool call. Always `custom_tool_call`.", + "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", "x-stainless-const": true }, "id": { "type": "string", - "description": "The unique ID of the custom tool call in the OpenAI platform." + "description": "The unique ID of the custom tool call output in the OpenAI platform." }, "call_id": { "type": "string", - "description": "An identifier used to map this custom tool call to a tool call output." + "description": "The call ID, used to map this custom tool call output to a custom tool call." }, - "name": { - "type": "string", - "description": "The name of the custom tool being called." + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." }, - "input": { + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { "type": "string", - "description": "The input for the custom tool call generated by the model." + "description": "The identifier of the actor that created the item." } }, "allOf": [ @@ -18343,46 +18497,57 @@ "$ref": "#/components/schemas/OpenAI.ConversationItem" } ], - "description": "A call to a custom tool created by the model.", - "title": "Custom tool call" + "title": "ResponseCustomToolCallOutputItem" }, - "OpenAI.ConversationItemCustomToolCallOutput": { + "OpenAI.ConversationItemCustomToolCallResource": { "type": "object", "required": [ "type", "call_id", - "output" + "name", + "input", + "status" ], "properties": { "type": { "type": "string", "enum": [ - "custom_tool_call_output" + "custom_tool_call" ], - "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", + "description": "The type of the custom tool call. Always `custom_tool_call`.", "x-stainless-const": true }, "id": { "type": "string", - "description": "The unique ID of the custom tool call output in the OpenAI platform." + "description": "The unique ID of the custom tool call in the OpenAI platform." }, "call_id": { "type": "string", - "description": "The call ID, used to map this custom tool call output to a custom tool call." + "description": "An identifier used to map this custom tool call to a tool call output." }, - "output": { - "oneOf": [ - { - "type": "string" - }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, + "name": { + "type": "string", + "description": "The name of the custom tool being called." + }, + "input": { + "type": "string", + "description": "The input for the custom tool call generated by the model." + }, + "status": { + "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" } ], - "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." } }, "allOf": [ @@ -18390,8 +18555,7 @@ "$ref": "#/components/schemas/OpenAI.ConversationItem" } ], - "description": "The output of a custom tool call from your code, being sent back to the model.", - "title": "Custom tool call output" + "title": "ResponseCustomToolCallItem" }, "OpenAI.ConversationItemFileSearchToolCall": { "type": "object", @@ -18487,7 +18651,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." @@ -18545,7 +18709,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -18579,43 +18743,44 @@ "description": "The output of a shell tool call that was emitted.", "title": "Shell call output" }, - "OpenAI.ConversationItemFunctionToolCallOutputResource": { + "OpenAI.ConversationItemFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", - "output" + "name", + "arguments" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", "enum": [ - "function_call_output" + "function_call" ], - "description": "The type of the function tool call output. Always `function_call_output`.", + "description": "The type of the function tool call. Always `function_call`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "output": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } - } - ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, + "name": { + "type": "string", + "description": "The name of the function to run." + }, + "arguments": { + "type": "string", + "description": "A JSON string of the arguments to pass to the function." }, "status": { "type": "string", @@ -18631,40 +18796,49 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ] + ], + "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", + "title": "Function tool call" }, - "OpenAI.ConversationItemFunctionToolCallResource": { + "OpenAI.ConversationItemFunctionToolCallOutput": { "type": "object", "required": [ + "id", "type", "call_id", - "name", - "arguments" + "output" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true }, "type": { "type": "string", "enum": [ - "function_call" + "function_call_output" ], - "description": "The type of the function tool call. Always `function_call`.", + "description": "The type of the function tool call output. Always `function_call_output`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "name": { - "type": "string", - "description": "The name of the function to run." - }, - "arguments": { - "type": "string", - "description": "A JSON string of the arguments to pass to the function." + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." }, "status": { "type": "string", @@ -18680,7 +18854,9 @@ { "$ref": "#/components/schemas/OpenAI.ConversationItem" } - ] + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" }, "OpenAI.ConversationItemImageGenToolCall": { "type": "object", @@ -18980,8 +19156,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -19100,6 +19275,14 @@ "$ref": "#/components/schemas/OpenAI.MessageContent" }, "description": "The content of the message" + }, + "phase": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + } + ], + "nullable": true } }, "allOf": [ @@ -19166,6 +19349,126 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, + "OpenAI.ConversationItemToolSearchCall": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "arguments", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search call item." + }, + "call_id": { + "type": "string", + "nullable": true + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ] + }, + "OpenAI.ConversationItemToolSearchOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "tools", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search output item." + }, + "call_id": { + "type": "string", + "nullable": true + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by tool search." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ConversationItem" + } + ] + }, "OpenAI.ConversationItemType": { "anyOf": [ { @@ -19182,7 +19485,10 @@ "image_generation_call", "computer_call", "computer_call_output", + "tool_search_call", + "tool_search_output", "reasoning", + "compaction", "code_interpreter_call", "local_shell_call", "local_shell_call_output", @@ -19371,7 +19677,8 @@ "propertyName": "type", "mapping": { "text": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText", - "json_object": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject" + "json_object": "#/components/schemas/OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject", + "json_schema": "#/components/schemas/OpenAI.ResponseFormatJsonSchema" } }, "description": "An object specifying the format that the model must output.\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables\nStructured Outputs which ensures the model will match your supplied JSON\nschema. Learn more in the [Structured Outputs\nguide](/docs/guides/structured-outputs).\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it." @@ -20340,6 +20647,10 @@ } ], "description": "The input format for the custom tool. Default is unconstrained text." + }, + "defer_loading": { + "type": "boolean", + "description": "Whether this tool should be deferred and discovered via tool search." } }, "allOf": [ @@ -20412,7 +20723,8 @@ "enum": [ "low", "high", - "auto" + "auto", + "original" ] }, "OpenAI.DoubleClickAction": { @@ -20420,7 +20732,8 @@ "required": [ "type", "x", - "y" + "y", + "keys" ], "properties": { "type": { @@ -20447,6 +20760,13 @@ } ], "description": "The y-coordinate where the double click occurred." + }, + "keys": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } }, "allOf": [ @@ -20479,6 +20799,13 @@ "$ref": "#/components/schemas/OpenAI.CoordParam" }, "description": "An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg\n ```\n [\n { x: 100, y: 200 },\n { x: 200, y: 300 }\n ]\n ```" + }, + "keys": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } }, "allOf": [ @@ -20518,6 +20845,14 @@ ], "description": "Text, image, or audio input to the model, used to generate a response.\n Can also contain previous assistant responses." }, + "phase": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + } + ], + "nullable": true + }, "type": { "type": "string", "enum": [ @@ -20544,6 +20879,9 @@ "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role. Messages with the\n`assistant` role are presumed to have been generated by the model in previous\ninteractions.", "title": "Input message" }, + "OpenAI.EmptyModelParam": { + "type": "object" + }, "OpenAI.Error": { "type": "object", "required": [ @@ -21511,6 +21849,13 @@ "description": "A citation to a file.", "title": "File citation" }, + "OpenAI.FileInputDetail": { + "type": "string", + "enum": [ + "low", + "high" + ] + }, "OpenAI.FilePath": { "type": "object", "required": [ @@ -22409,14 +22754,22 @@ "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "allOf": [ @@ -22458,7 +22811,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -22521,14 +22874,30 @@ "incomplete" ] }, - "OpenAI.FunctionObject": { - "type": "object", - "required": [ - "name" - ], - "properties": { - "description": { - "type": "string", + "OpenAI.FunctionCallOutputStatusEnum": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + "OpenAI.FunctionCallStatus": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, + "OpenAI.FunctionObject": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "description": { + "type": "string", "description": "A description of what the function does, used by the model to choose when and how to call the function." }, "name": { @@ -22949,6 +23318,14 @@ } ] }, + "OpenAI.FunctionShellCallOutputStatusEnum": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, "OpenAI.FunctionShellCallOutputTimeoutOutcome": { "type": "object", "required": [ @@ -22997,6 +23374,14 @@ "description": "Indicates that the shell call exceeded its configured time limit.", "title": "Shell call timeout outcome" }, + "OpenAI.FunctionShellCallStatus": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ] + }, "OpenAI.FunctionShellToolParam": { "type": "object", "required": [ @@ -23155,6 +23540,10 @@ "strict": { "type": "boolean", "nullable": true + }, + "defer_loading": { + "type": "boolean", + "description": "Whether this function is deferred and loaded via tool search." } }, "allOf": [ @@ -23165,61 +23554,49 @@ "description": "Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).", "title": "Function" }, - "OpenAI.FunctionToolCallOutput": { + "OpenAI.FunctionToolParam": { "type": "object", "required": [ - "type", - "call_id", - "output" + "name", + "type" ], "properties": { - "id": { - "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." - }, - "type": { + "name": { "type": "string", - "enum": [ - "function_call_output" - ], - "description": "The type of the function tool call output. Always `function_call_output`.", - "x-stainless-const": true + "minLength": 1, + "maxLength": 128, + "pattern": "^[a-zA-Z0-9_-]+$" }, - "call_id": { + "description": { "type": "string", - "description": "The unique ID of the function tool call generated by the model." + "nullable": true }, - "output": { - "oneOf": [ - { - "type": "string" - }, + "parameters": { + "type": "object", + "allOf": [ { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" } ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + "nullable": true }, - "status": { + "strict": { + "type": "boolean", + "nullable": true + }, + "type": { "type": "string", "enum": [ - "in_progress", - "completed", - "incomplete" + "function" ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemField" + "x-stainless-const": true, + "default": "function" + }, + "defer_loading": { + "type": "boolean", + "description": "Whether this function should be deferred and discovered via tool search." } - ], - "description": "The output of a function tool call.", - "title": "Function tool call output" + } }, "OpenAI.GraderLabelModel": { "type": "object", @@ -23567,7 +23944,8 @@ "enum": [ "low", "high", - "auto" + "auto", + "original" ] }, "OpenAI.ImageGenActionEnum": { @@ -23621,14 +23999,21 @@ "default": "auto" }, "size": { - "type": "string", - "enum": [ - "1024x1024", - "1024x1536", - "1536x1024", - "auto" + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "1024x1024", + "1024x1536", + "1536x1024", + "auto" + ] + } ], - "description": "The size of the generated image. One of `1024x1024`, `1024x1536`,\n `1536x1024`, or `auto`. Default: `auto`.", + "description": "The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.", "default": "auto" }, "output_format": { @@ -23746,7 +24131,7 @@ ] } ], - "description": "Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program)." + "description": "Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.results`: Include the search results of the web search tool call.\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program)." }, "OpenAI.InlineSkillParam": { "type": "object", @@ -23912,14 +24297,22 @@ "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "allOf": [ @@ -23961,7 +24354,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -24047,14 +24440,22 @@ "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "description": "A file input to the model.", @@ -24091,6 +24492,14 @@ "type": "string", "format": "uri", "nullable": true + }, + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "description": "A file input to the model.", @@ -24127,7 +24536,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "description": "An image input to the model. Learn about [image inputs](/docs/guides/vision).", @@ -24191,6 +24600,8 @@ "web_search_call": "#/components/schemas/OpenAI.InputItemWebSearchToolCall", "function_call": "#/components/schemas/OpenAI.InputItemFunctionToolCall", "function_call_output": "#/components/schemas/OpenAI.InputItemFunctionCallOutputItemParam", + "tool_search_call": "#/components/schemas/OpenAI.InputItemToolSearchCallItemParam", + "tool_search_output": "#/components/schemas/OpenAI.InputItemToolSearchOutputItemParam", "reasoning": "#/components/schemas/OpenAI.InputItemReasoningItem", "compaction": "#/components/schemas/OpenAI.InputItemCompactionSummaryItemParam", "image_generation_call": "#/components/schemas/OpenAI.InputItemImageGenToolCall", @@ -24472,7 +24883,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -24496,6 +24906,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -24546,6 +24959,10 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -24857,6 +25274,7 @@ "OpenAI.InputItemFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", "name", @@ -24865,7 +25283,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", @@ -24879,6 +25298,10 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, "name": { "type": "string", "description": "The name of the function to run." @@ -25155,8 +25578,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -25267,6 +25689,14 @@ }, "description": "The content of the output message." }, + "phase": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + } + ], + "nullable": true + }, "status": { "type": "string", "enum": [ @@ -25341,6 +25771,115 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, + "OpenAI.InputItemToolSearchCallItemParam": { + "type": "object", + "required": [ + "type", + "arguments" + ], + "properties": { + "id": { + "type": "string", + "nullable": true + }, + "call_id": { + "type": "string", + "nullable": true + }, + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The item type. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" + } + ], + "description": "The arguments supplied to the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + } + ], + "nullable": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.InputItem" + } + ] + }, + "OpenAI.InputItemToolSearchOutputItemParam": { + "type": "object", + "required": [ + "type", + "tools" + ], + "properties": { + "id": { + "type": "string", + "nullable": true + }, + "call_id": { + "type": "string", + "nullable": true + }, + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The item type. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by the tool search output." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + } + ], + "nullable": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.InputItem" + } + ] + }, "OpenAI.InputItemType": { "anyOf": [ { @@ -25357,6 +25896,8 @@ "web_search_call", "function_call", "function_call_output", + "tool_search_call", + "tool_search_output", "reasoning", "compaction", "image_generation_call", @@ -25432,52 +25973,6 @@ "description": "The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.", "title": "Web search tool call" }, - "OpenAI.InputMessage": { - "type": "object", - "required": [ - "type", - "role", - "content" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "message" - ], - "description": "The type of the message input. Always set to `message`.", - "x-stainless-const": true - }, - "role": { - "type": "string", - "enum": [ - "user", - "system", - "developer" - ], - "description": "The role of the message input. One of `user`, `system`, or `developer`." - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "content": { - "$ref": "#/components/schemas/OpenAI.InputMessageContentList" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.Item" - } - ], - "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", - "title": "Input message" - }, "OpenAI.InputMessageContentList": { "type": "array", "items": { @@ -25486,55 +25981,6 @@ "description": "A list of one or many input items to the model, containing different content\ntypes.", "title": "Input item content list" }, - "OpenAI.InputMessageResource": { - "type": "object", - "required": [ - "type", - "role", - "content", - "id" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "message" - ], - "description": "The type of the message input. Always set to `message`.", - "x-stainless-const": true - }, - "role": { - "type": "string", - "enum": [ - "user", - "system", - "developer" - ], - "description": "The role of the message input. One of `user`, `system`, or `developer`." - }, - "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ], - "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." - }, - "content": { - "$ref": "#/components/schemas/OpenAI.InputMessageContentList" - }, - "id": { - "type": "string", - "description": "The unique ID of the message input." - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.ItemResource" - } - ] - }, "OpenAI.InputParam": { "oneOf": [ { @@ -25612,7 +26058,7 @@ "propertyName": "type", "mapping": { "memory_search_call": "#/components/schemas/MemorySearchToolCallItemParam", - "message": "#/components/schemas/OpenAI.InputMessage", + "message": "#/components/schemas/OpenAI.ItemInputMessage", "output_message": "#/components/schemas/OpenAI.ItemOutputMessage", "file_search_call": "#/components/schemas/OpenAI.ItemFileSearchToolCall", "computer_call": "#/components/schemas/OpenAI.ItemComputerToolCall", @@ -25620,6 +26066,8 @@ "web_search_call": "#/components/schemas/OpenAI.ItemWebSearchToolCall", "function_call": "#/components/schemas/OpenAI.ItemFunctionToolCall", "function_call_output": "#/components/schemas/OpenAI.ItemFunctionCallOutputItemParam", + "tool_search_call": "#/components/schemas/OpenAI.ItemToolSearchCallItemParam", + "tool_search_output": "#/components/schemas/OpenAI.ItemToolSearchOutputItemParam", "reasoning": "#/components/schemas/OpenAI.ItemReasoningItem", "compaction": "#/components/schemas/OpenAI.ItemCompactionSummaryItemParam", "image_generation_call": "#/components/schemas/OpenAI.ItemImageGenToolCall", @@ -25901,7 +26349,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -25925,6 +26372,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -25975,6 +26425,10 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -26052,14 +26506,16 @@ "discriminator": { "propertyName": "type", "mapping": { - "function_call_output": "#/components/schemas/OpenAI.FunctionToolCallOutput", "message": "#/components/schemas/OpenAI.ItemFieldMessage", "function_call": "#/components/schemas/OpenAI.ItemFieldFunctionToolCall", + "tool_search_call": "#/components/schemas/OpenAI.ItemFieldToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.ItemFieldToolSearchOutput", + "function_call_output": "#/components/schemas/OpenAI.ItemFieldFunctionToolCallOutput", "file_search_call": "#/components/schemas/OpenAI.ItemFieldFileSearchToolCall", "web_search_call": "#/components/schemas/OpenAI.ItemFieldWebSearchToolCall", "image_generation_call": "#/components/schemas/OpenAI.ItemFieldImageGenToolCall", "computer_call": "#/components/schemas/OpenAI.ItemFieldComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ItemFieldComputerToolCallOutputResource", + "computer_call_output": "#/components/schemas/OpenAI.ItemFieldComputerToolCallOutput", "reasoning": "#/components/schemas/OpenAI.ItemFieldReasoningItem", "compaction": "#/components/schemas/OpenAI.ItemFieldCompactionBody", "code_interpreter_call": "#/components/schemas/OpenAI.ItemFieldCodeInterpreterToolCall", @@ -26297,7 +26753,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -26321,6 +26776,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -26346,10 +26804,11 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ItemFieldComputerToolCallOutputResource": { + "OpenAI.ItemFieldComputerToolCallOutput": { "type": "object", "required": [ "type", + "id", "call_id", "output" ], @@ -26365,7 +26824,8 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output." + "description": "The ID of the computer tool call output.", + "readOnly": true }, "call_id": { "type": "string", @@ -26395,7 +26855,9 @@ { "$ref": "#/components/schemas/OpenAI.ItemField" } - ] + ], + "description": "The output of a computer tool call.", + "title": "Computer tool call output" }, "OpenAI.ItemFieldCustomToolCall": { "type": "object", @@ -26422,6 +26884,10 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." @@ -26580,7 +27046,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." @@ -26638,7 +27104,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -26675,6 +27141,7 @@ "OpenAI.ItemFieldFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", "name", @@ -26683,7 +27150,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", @@ -26697,6 +27165,10 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, "name": { "type": "string", "description": "The name of the function to run." @@ -26723,6 +27195,64 @@ "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", "title": "Function tool call" }, + "OpenAI.ItemFieldFunctionToolCallOutput": { + "type": "object", + "required": [ + "id", + "type", + "call_id", + "output" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true + }, + "type": { + "type": "string", + "enum": [ + "function_call_output" + ], + "description": "The type of the function tool call output. Always `function_call_output`.", + "x-stainless-const": true + }, + "call_id": { + "type": "string", + "description": "The unique ID of the function tool call generated by the model." + }, + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" + }, "OpenAI.ItemFieldImageGenToolCall": { "type": "object", "required": [ @@ -26974,8 +27504,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -27094,6 +27623,14 @@ "$ref": "#/components/schemas/OpenAI.MessageContent" }, "description": "The content of the message" + }, + "phase": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + } + ], + "nullable": true } }, "allOf": [ @@ -27160,93 +27697,215 @@ "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", "title": "Reasoning" }, - "OpenAI.ItemFieldType": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "enum": [ - "message", - "function_call", - "function_call_output", - "file_search_call", - "web_search_call", - "image_generation_call", - "computer_call", - "computer_call_output", - "reasoning", - "compaction", - "code_interpreter_call", - "local_shell_call", - "local_shell_call_output", - "shell_call", - "shell_call_output", - "apply_patch_call", - "apply_patch_call_output", - "mcp_list_tools", - "mcp_approval_request", - "mcp_approval_response", - "mcp_call", - "custom_tool_call", - "custom_tool_call_output" - ] - } - ] - }, - "OpenAI.ItemFieldWebSearchToolCall": { + "OpenAI.ItemFieldToolSearchCall": { "type": "object", "required": [ - "id", "type", - "status", - "action" + "id", + "call_id", + "execution", + "arguments", + "status" ], "properties": { - "id": { - "type": "string", - "description": "The unique ID of the web search tool call." - }, "type": { "type": "string", "enum": [ - "web_search_call" + "tool_search_call" ], - "description": "The type of the web search tool call. Always `web_search_call`.", - "x-stainless-const": true + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" }, - "status": { + "id": { "type": "string", - "enum": [ - "in_progress", - "searching", - "completed", - "failed" - ], - "description": "The status of the web search tool call." + "description": "The unique ID of the tool search call item." }, - "action": { - "oneOf": [ - { - "$ref": "#/components/schemas/OpenAI.WebSearchActionSearch" - }, + "call_id": { + "type": "string", + "nullable": true + }, + "execution": { + "allOf": [ { - "$ref": "#/components/schemas/OpenAI.WebSearchActionOpenPage" - }, + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ { - "$ref": "#/components/schemas/OpenAI.WebSearchActionFind" + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" } ], - "description": "An object describing the specific action taken in this web search call.\n Includes details on how the model used the web (search, open_page, find_in_page)." + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." } }, "allOf": [ { "$ref": "#/components/schemas/OpenAI.ItemField" } - ], - "description": "The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.", + ] + }, + "OpenAI.ItemFieldToolSearchOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "tools", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search output item." + }, + "call_id": { + "type": "string", + "nullable": true + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by tool search." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ] + }, + "OpenAI.ItemFieldType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "message", + "function_call", + "tool_search_call", + "tool_search_output", + "function_call_output", + "file_search_call", + "web_search_call", + "image_generation_call", + "computer_call", + "computer_call_output", + "reasoning", + "compaction", + "code_interpreter_call", + "local_shell_call", + "local_shell_call_output", + "shell_call", + "shell_call_output", + "apply_patch_call", + "apply_patch_call_output", + "mcp_list_tools", + "mcp_approval_request", + "mcp_approval_response", + "mcp_call", + "custom_tool_call", + "custom_tool_call_output" + ] + } + ] + }, + "OpenAI.ItemFieldWebSearchToolCall": { + "type": "object", + "required": [ + "id", + "type", + "status", + "action" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the web search tool call." + }, + "type": { + "type": "string", + "enum": [ + "web_search_call" + ], + "description": "The type of the web search tool call. Always `web_search_call`.", + "x-stainless-const": true + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "searching", + "completed", + "failed" + ], + "description": "The status of the web search tool call." + }, + "action": { + "oneOf": [ + { + "$ref": "#/components/schemas/OpenAI.WebSearchActionSearch" + }, + { + "$ref": "#/components/schemas/OpenAI.WebSearchActionOpenPage" + }, + { + "$ref": "#/components/schemas/OpenAI.WebSearchActionFind" + } + ], + "description": "An object describing the specific action taken in this web search call.\n Includes details on how the model used the web (search, open_page, find_in_page)." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemField" + } + ], + "description": "The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.", "title": "Web search tool call" }, "OpenAI.ItemFileSearchToolCall": { @@ -27496,6 +28155,7 @@ "OpenAI.ItemFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", "name", @@ -27504,7 +28164,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", @@ -27518,6 +28179,10 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, "name": { "type": "string", "description": "The name of the function to run." @@ -27588,6 +28253,59 @@ "description": "An image generation request made by the model.", "title": "Image generation call" }, + "OpenAI.ItemInputMessage": { + "type": "object", + "required": [ + "type", + "role", + "content", + "id" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "message" + ], + "description": "The type of the message input. Always set to `message`.", + "x-stainless-const": true, + "default": "message" + }, + "role": { + "type": "string", + "enum": [ + "user", + "system", + "developer" + ], + "description": "The role of the message input. One of `user`, `system`, or `developer`." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "content": { + "$ref": "#/components/schemas/OpenAI.InputMessageContentList" + }, + "id": { + "type": "string", + "description": "The unique ID of the message input.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ], + "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", + "title": "Input message" + }, "OpenAI.ItemLocalShellToolCall": { "type": "object", "required": [ @@ -27794,8 +28512,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -27906,6 +28623,14 @@ }, "description": "The content of the output message." }, + "phase": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + } + ], + "nullable": true + }, "status": { "type": "string", "enum": [ @@ -28022,14 +28747,18 @@ "discriminator": { "propertyName": "type", "mapping": { - "message": "#/components/schemas/OpenAI.InputMessageResource", + "message": "#/components/schemas/OpenAI.ItemResourceInputMessage", "output_message": "#/components/schemas/OpenAI.ItemResourceOutputMessage", "file_search_call": "#/components/schemas/OpenAI.ItemResourceFileSearchToolCall", "computer_call": "#/components/schemas/OpenAI.ItemResourceComputerToolCall", - "computer_call_output": "#/components/schemas/OpenAI.ItemResourceComputerToolCallOutputResource", + "computer_call_output": "#/components/schemas/OpenAI.ItemResourceComputerToolCallOutput", "web_search_call": "#/components/schemas/OpenAI.ItemResourceWebSearchToolCall", - "function_call": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallResource", - "function_call_output": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutputResource", + "function_call": "#/components/schemas/OpenAI.ItemResourceFunctionToolCall", + "function_call_output": "#/components/schemas/OpenAI.ItemResourceFunctionToolCallOutput", + "tool_search_call": "#/components/schemas/OpenAI.ItemResourceToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.ItemResourceToolSearchOutput", + "reasoning": "#/components/schemas/OpenAI.ItemResourceReasoningItem", + "compaction": "#/components/schemas/OpenAI.ItemResourceCompactionBody", "image_generation_call": "#/components/schemas/OpenAI.ItemResourceImageGenToolCall", "code_interpreter_call": "#/components/schemas/OpenAI.ItemResourceCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.ItemResourceLocalShellToolCall", @@ -28041,7 +28770,9 @@ "mcp_list_tools": "#/components/schemas/OpenAI.ItemResourceMcpListTools", "mcp_approval_request": "#/components/schemas/OpenAI.ItemResourceMcpApprovalRequest", "mcp_approval_response": "#/components/schemas/OpenAI.ItemResourceMcpApprovalResponseResource", - "mcp_call": "#/components/schemas/OpenAI.ItemResourceMcpToolCall" + "mcp_call": "#/components/schemas/OpenAI.ItemResourceMcpToolCall", + "custom_tool_call": "#/components/schemas/OpenAI.ItemResourceCustomToolCallResource", + "custom_tool_call_output": "#/components/schemas/OpenAI.ItemResourceCustomToolCallOutputResource" } }, "description": "Content item used to generate a response." @@ -28220,13 +28951,50 @@ "description": "A tool call to run code.", "title": "Code interpreter tool call" }, + "OpenAI.ItemResourceCompactionBody": { + "type": "object", + "required": [ + "type", + "id", + "encrypted_content" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "compaction" + ], + "description": "The type of the item. Always `compaction`.", + "x-stainless-const": true, + "default": "compaction" + }, + "id": { + "type": "string", + "description": "The unique ID of the compaction item." + }, + "encrypted_content": { + "type": "string", + "description": "The encrypted content that was produced by compaction." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "description": "A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact).", + "title": "Compaction item" + }, "OpenAI.ItemResourceComputerToolCall": { "type": "object", "required": [ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -28250,6 +29018,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -28275,10 +29046,11 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.ItemResourceComputerToolCallOutputResource": { + "OpenAI.ItemResourceComputerToolCallOutput": { "type": "object", "required": [ "type", + "id", "call_id", "output" ], @@ -28294,7 +29066,8 @@ }, "id": { "type": "string", - "description": "The ID of the computer tool call output." + "description": "The ID of the computer tool call output.", + "readOnly": true }, "call_id": { "type": "string", @@ -28324,20 +29097,139 @@ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ] + ], + "description": "The output of a computer tool call.", + "title": "Computer tool call output" }, - "OpenAI.ItemResourceFileSearchToolCall": { + "OpenAI.ItemResourceCustomToolCallOutputResource": { "type": "object", "required": [ - "id", "type", - "status", - "queries" + "call_id", + "output", + "status" ], "properties": { - "id": { + "type": { "type": "string", - "description": "The unique ID of the file search tool call." + "enum": [ + "custom_tool_call_output" + ], + "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the custom tool call output in the OpenAI platform." + }, + "call_id": { + "type": "string", + "description": "The call ID, used to map this custom tool call output to a custom tool call." + }, + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "title": "ResponseCustomToolCallOutputItem" + }, + "OpenAI.ItemResourceCustomToolCallResource": { + "type": "object", + "required": [ + "type", + "call_id", + "name", + "input", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "custom_tool_call" + ], + "description": "The type of the custom tool call. Always `custom_tool_call`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the custom tool call in the OpenAI platform." + }, + "call_id": { + "type": "string", + "description": "An identifier used to map this custom tool call to a tool call output." + }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, + "name": { + "type": "string", + "description": "The name of the custom tool being called." + }, + "input": { + "type": "string", + "description": "The input for the custom tool call generated by the model." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "title": "ResponseCustomToolCallItem" + }, + "OpenAI.ItemResourceFileSearchToolCall": { + "type": "object", + "required": [ + "id", + "type", + "status", + "queries" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the file search tool call." }, "type": { "type": "string", @@ -28420,7 +29312,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." @@ -28478,7 +29370,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -28512,43 +29404,44 @@ "description": "The output of a shell tool call that was emitted.", "title": "Shell call output" }, - "OpenAI.ItemResourceFunctionToolCallOutputResource": { + "OpenAI.ItemResourceFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", - "output" + "name", + "arguments" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", "enum": [ - "function_call_output" + "function_call" ], - "description": "The type of the function tool call output. Always `function_call_output`.", + "description": "The type of the function tool call. Always `function_call`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "output": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" - } - } - ], - "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, + "name": { + "type": "string", + "description": "The name of the function to run." + }, + "arguments": { + "type": "string", + "description": "A JSON string of the arguments to pass to the function." }, "status": { "type": "string", @@ -28564,40 +29457,49 @@ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ] + ], + "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", + "title": "Function tool call" }, - "OpenAI.ItemResourceFunctionToolCallResource": { + "OpenAI.ItemResourceFunctionToolCallOutput": { "type": "object", "required": [ + "id", "type", "call_id", - "name", - "arguments" + "output" ], "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true }, "type": { "type": "string", "enum": [ - "function_call" + "function_call_output" ], - "description": "The type of the function tool call. Always `function_call`.", + "description": "The type of the function tool call output. Always `function_call_output`.", "x-stainless-const": true }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model." }, - "name": { - "type": "string", - "description": "The name of the function to run." - }, - "arguments": { - "type": "string", - "description": "A JSON string of the arguments to pass to the function." + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." }, "status": { "type": "string", @@ -28613,7 +29515,9 @@ { "$ref": "#/components/schemas/OpenAI.ItemResource" } - ] + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" }, "OpenAI.ItemResourceImageGenToolCall": { "type": "object", @@ -28659,6 +29563,59 @@ "description": "An image generation request made by the model.", "title": "Image generation call" }, + "OpenAI.ItemResourceInputMessage": { + "type": "object", + "required": [ + "type", + "role", + "content", + "id" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "message" + ], + "description": "The type of the message input. Always set to `message`.", + "x-stainless-const": true, + "default": "message" + }, + "role": { + "type": "string", + "enum": [ + "user", + "system", + "developer" + ], + "description": "The role of the message input. One of `user`, `system`, or `developer`." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "content": { + "$ref": "#/components/schemas/OpenAI.InputMessageContentList" + }, + "id": { + "type": "string", + "description": "The unique ID of the message input.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.", + "title": "Input message" + }, "OpenAI.ItemResourceLocalShellToolCall": { "type": "object", "required": [ @@ -28866,8 +29823,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -28978,6 +29934,14 @@ }, "description": "The content of the output message." }, + "phase": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + } + ], + "nullable": true + }, "status": { "type": "string", "enum": [ @@ -28996,22 +29960,202 @@ "description": "An output message from the model.", "title": "Output message" }, - "OpenAI.ItemResourceType": { - "anyOf": [ - { - "type": "string" - }, - { + "OpenAI.ItemResourceReasoningItem": { + "type": "object", + "required": [ + "type", + "id", + "summary" + ], + "properties": { + "type": { "type": "string", "enum": [ - "message", - "output_message", - "file_search_call", - "computer_call", + "reasoning" + ], + "description": "The type of the object. Always `reasoning`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique identifier of the reasoning content." + }, + "encrypted_content": { + "type": "string", + "nullable": true + }, + "summary": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.SummaryTextContent" + }, + "description": "Reasoning summary content." + }, + "content": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ReasoningTextContent" + }, + "description": "Reasoning text content." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ], + "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", + "title": "Reasoning" + }, + "OpenAI.ItemResourceToolSearchCall": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "arguments", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search call item." + }, + "call_id": { + "type": "string", + "nullable": true + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ] + }, + "OpenAI.ItemResourceToolSearchOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "tools", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search output item." + }, + "call_id": { + "type": "string", + "nullable": true + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by tool search." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ItemResource" + } + ] + }, + "OpenAI.ItemResourceType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "message", + "output_message", + "file_search_call", + "computer_call", "computer_call_output", "web_search_call", "function_call", "function_call_output", + "tool_search_call", + "tool_search_output", + "reasoning", + "compaction", "image_generation_call", "code_interpreter_call", "local_shell_call", @@ -29024,6 +30168,8 @@ "mcp_approval_request", "mcp_approval_response", "mcp_call", + "custom_tool_call", + "custom_tool_call_output", "structured_outputs", "oauth_consent_request", "memory_search_call", @@ -29104,6 +30250,115 @@ "description": "The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.", "title": "Web search tool call" }, + "OpenAI.ItemToolSearchCallItemParam": { + "type": "object", + "required": [ + "type", + "arguments" + ], + "properties": { + "id": { + "type": "string", + "nullable": true + }, + "call_id": { + "type": "string", + "nullable": true + }, + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The item type. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" + } + ], + "description": "The arguments supplied to the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + } + ], + "nullable": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ] + }, + "OpenAI.ItemToolSearchOutputItemParam": { + "type": "object", + "required": [ + "type", + "tools" + ], + "properties": { + "id": { + "type": "string", + "nullable": true + }, + "call_id": { + "type": "string", + "nullable": true + }, + "type": { + "type": "string", + "enum": [ + "tool_search_output" + ], + "description": "The item type. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.Tool" + }, + "description": "The loaded tool definitions returned by the tool search output." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallItemStatus" + } + ], + "nullable": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Item" + } + ] + }, "OpenAI.ItemType": { "anyOf": [ { @@ -29120,6 +30375,8 @@ "web_search_call", "function_call", "function_call_output", + "tool_search_call", + "tool_search_output", "reasoning", "compaction", "image_generation_call", @@ -29362,22 +30619,6 @@ "description": "Represents the use of a local environment to perform shell actions.", "title": "Local Environment" }, - "OpenAI.LocalShellCallOutputStatusEnum": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, - "OpenAI.LocalShellCallStatus": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" - ] - }, "OpenAI.LocalShellExecAction": { "type": "object", "required": [ @@ -29645,6 +30886,10 @@ ], "default": "always" }, + "defer_loading": { + "type": "boolean", + "description": "Whether this MCP tool is deferred and discovered via tool search." + }, "project_connection_id": { "type": "string", "description": "The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server." @@ -29718,7 +30963,8 @@ "reasoning_text": "#/components/schemas/OpenAI.MessageContentReasoningTextContent", "refusal": "#/components/schemas/OpenAI.MessageContentRefusalContent", "input_image": "#/components/schemas/OpenAI.MessageContentInputImageContent", - "input_file": "#/components/schemas/OpenAI.MessageContentInputFileContent" + "input_file": "#/components/schemas/OpenAI.MessageContentInputFileContent", + "summary_text": "#/components/schemas/OpenAI.SummaryTextContent" } }, "description": "A content part that makes up an input or output item." @@ -29746,14 +30992,22 @@ "type": "string", "description": "The name of the file to be sent to the model." }, + "file_data": { + "type": "string", + "description": "The content of the file to be sent to the model." + }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, - "file_data": { - "type": "string", - "description": "The content of the file to be sent to the model." + "detail": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FileInputDetail" + } + ], + "description": "The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`." } }, "allOf": [ @@ -29795,7 +31049,7 @@ "$ref": "#/components/schemas/OpenAI.ImageDetail" } ], - "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`." + "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." } }, "allOf": [ @@ -29958,6 +31212,14 @@ } ] }, + "OpenAI.MessagePhase": { + "type": "string", + "enum": [ + "commentary", + "final_answer" + ], + "description": "Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`).\nFor models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend\nphase on all assistant messages — dropping it can degrade performance. Not used for user messages." + }, "OpenAI.MessageRole": { "type": "string", "enum": [ @@ -30074,6 +31336,13 @@ } ], "description": "The y-coordinate to move to." + }, + "keys": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } }, "allOf": [ @@ -30084,6 +31353,58 @@ "description": "A mouse move action.", "title": "Move" }, + "OpenAI.NamespaceToolParam": { + "type": "object", + "required": [ + "type", + "name", + "description", + "tools" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "namespace" + ], + "description": "The type of the tool. Always `namespace`.", + "x-stainless-const": true, + "default": "namespace" + }, + "name": { + "type": "string", + "minLength": 1, + "description": "The namespace name used in tool calls (for example, `crm`)." + }, + "description": { + "type": "string", + "minLength": 1, + "description": "A description of the namespace shown to the model." + }, + "tools": { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionToolParam" + }, + { + "$ref": "#/components/schemas/OpenAI.CustomToolParam" + } + ] + }, + "minItems": 1, + "description": "The function/custom tools available inside this namespace." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Tool" + } + ], + "description": "Groups function/custom tools under a shared namespace.", + "title": "Namespace" + }, "OpenAI.OutputContent": { "type": "object", "required": [ @@ -30281,13 +31602,18 @@ "output_message": "#/components/schemas/OpenAI.OutputItemOutputMessage", "file_search_call": "#/components/schemas/OpenAI.OutputItemFileSearchToolCall", "function_call": "#/components/schemas/OpenAI.OutputItemFunctionToolCall", + "function_call_output": "#/components/schemas/OpenAI.OutputItemFunctionToolCallOutput", "web_search_call": "#/components/schemas/OpenAI.OutputItemWebSearchToolCall", "computer_call": "#/components/schemas/OpenAI.OutputItemComputerToolCall", + "computer_call_output": "#/components/schemas/OpenAI.OutputItemComputerToolCallOutput", "reasoning": "#/components/schemas/OpenAI.OutputItemReasoningItem", + "tool_search_call": "#/components/schemas/OpenAI.OutputItemToolSearchCall", + "tool_search_output": "#/components/schemas/OpenAI.OutputItemToolSearchOutput", "compaction": "#/components/schemas/OpenAI.OutputItemCompactionBody", "image_generation_call": "#/components/schemas/OpenAI.OutputItemImageGenToolCall", "code_interpreter_call": "#/components/schemas/OpenAI.OutputItemCodeInterpreterToolCall", "local_shell_call": "#/components/schemas/OpenAI.OutputItemLocalShellToolCall", + "local_shell_call_output": "#/components/schemas/OpenAI.OutputItemLocalShellToolCallOutput", "shell_call": "#/components/schemas/OpenAI.OutputItemFunctionShellCall", "shell_call_output": "#/components/schemas/OpenAI.OutputItemFunctionShellCallOutput", "apply_patch_call": "#/components/schemas/OpenAI.OutputItemApplyPatchToolCall", @@ -30295,7 +31621,9 @@ "mcp_call": "#/components/schemas/OpenAI.OutputItemMcpToolCall", "mcp_list_tools": "#/components/schemas/OpenAI.OutputItemMcpListTools", "mcp_approval_request": "#/components/schemas/OpenAI.OutputItemMcpApprovalRequest", - "custom_tool_call": "#/components/schemas/OpenAI.OutputItemCustomToolCall" + "mcp_approval_response": "#/components/schemas/OpenAI.OutputItemMcpApprovalResponseResource", + "custom_tool_call": "#/components/schemas/OpenAI.OutputItemCustomToolCallResource", + "custom_tool_call_output": "#/components/schemas/OpenAI.OutputItemCustomToolCallOutputResource" } } }, @@ -30517,7 +31845,6 @@ "type", "id", "call_id", - "action", "pending_safety_checks", "status" ], @@ -30541,6 +31868,9 @@ "action": { "$ref": "#/components/schemas/OpenAI.ComputerAction" }, + "actions": { + "$ref": "#/components/schemas/OpenAI.ComputerActionList" + }, "pending_safety_checks": { "type": "array", "items": { @@ -30566,13 +31896,128 @@ "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.", "title": "Computer tool call" }, - "OpenAI.OutputItemCustomToolCall": { + "OpenAI.OutputItemComputerToolCallOutput": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "output" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer_call_output" + ], + "description": "The type of the computer tool call output. Always `computer_call_output`.", + "x-stainless-const": true, + "default": "computer_call_output" + }, + "id": { + "type": "string", + "description": "The ID of the computer tool call output.", + "readOnly": true + }, + "call_id": { + "type": "string", + "description": "The ID of the computer tool call that produced the output." + }, + "acknowledged_safety_checks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ComputerCallSafetyCheckParam" + }, + "description": "The safety checks reported by the API that have been acknowledged by the\n developer." + }, + "output": { + "$ref": "#/components/schemas/OpenAI.ComputerScreenshotImage" + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the message input. One of `in_progress`, `completed`, or\n `incomplete`. Populated when input items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "The output of a computer tool call.", + "title": "Computer tool call output" + }, + "OpenAI.OutputItemCustomToolCallOutputResource": { + "type": "object", + "required": [ + "type", + "call_id", + "output", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "custom_tool_call_output" + ], + "description": "The type of the custom tool call output. Always `custom_tool_call_output`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the custom tool call output in the OpenAI platform." + }, + "call_id": { + "type": "string", + "description": "The call ID, used to map this custom tool call output to a custom tool call." + }, + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the custom tool call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "title": "ResponseCustomToolCallOutputItem" + }, + "OpenAI.OutputItemCustomToolCallResource": { "type": "object", "required": [ "type", "call_id", "name", - "input" + "input", + "status" ], "properties": { "type": { @@ -30591,13 +32036,29 @@ "type": "string", "description": "An identifier used to map this custom tool call to a tool call output." }, + "namespace": { + "type": "string", + "description": "The namespace of the custom tool being called." + }, "name": { "type": "string", "description": "The name of the custom tool being called." }, "input": { "type": "string", - "description": "The input for the custom tool call generated by the model." + "description": "The input for the custom tool call generated by the model." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." } }, "allOf": [ @@ -30605,8 +32066,7 @@ "$ref": "#/components/schemas/OpenAI.OutputItem" } ], - "description": "A call to a custom tool created by the model.", - "title": "Custom tool call" + "title": "ResponseCustomToolCallItem" }, "OpenAI.OutputItemFileSearchToolCall": { "type": "object", @@ -30702,7 +32162,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallStatus" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallStatus" } ], "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." @@ -30760,7 +32220,7 @@ "status": { "allOf": [ { - "$ref": "#/components/schemas/OpenAI.LocalShellCallOutputStatusEnum" + "$ref": "#/components/schemas/OpenAI.FunctionShellCallOutputStatusEnum" } ], "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." @@ -30797,6 +32257,7 @@ "OpenAI.OutputItemFunctionToolCall": { "type": "object", "required": [ + "id", "type", "call_id", "name", @@ -30805,7 +32266,8 @@ "properties": { "id": { "type": "string", - "description": "The unique ID of the function tool call." + "description": "The unique ID of the function tool call.", + "readOnly": true }, "type": { "type": "string", @@ -30819,6 +32281,10 @@ "type": "string", "description": "The unique ID of the function tool call generated by the model." }, + "namespace": { + "type": "string", + "description": "The namespace of the function to run." + }, "name": { "type": "string", "description": "The name of the function to run." @@ -30845,6 +32311,64 @@ "description": "A tool call to run a function. See the\n[function calling guide](/docs/guides/function-calling) for more information.", "title": "Function tool call" }, + "OpenAI.OutputItemFunctionToolCallOutput": { + "type": "object", + "required": [ + "id", + "type", + "call_id", + "output" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the function tool call output. Populated when this item\n is returned via API.", + "readOnly": true + }, + "type": { + "type": "string", + "enum": [ + "function_call_output" + ], + "description": "The type of the function tool call output. Always `function_call_output`.", + "x-stainless-const": true + }, + "call_id": { + "type": "string", + "description": "The unique ID of the function tool call generated by the model." + }, + "output": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.FunctionAndCustomToolCallOutput" + } + } + ], + "description": "The output from the function call generated by your code.\n Can be a string or an list of output content." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "The output of a function tool call.", + "title": "Function tool call output" + }, "OpenAI.OutputItemImageGenToolCall": { "type": "object", "required": [ @@ -30936,6 +32460,48 @@ "description": "A tool call to run a command on the local shell.", "title": "Local shell call" }, + "OpenAI.OutputItemLocalShellToolCallOutput": { + "type": "object", + "required": [ + "type", + "id", + "output" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "local_shell_call_output" + ], + "description": "The type of the local shell tool call output. Always `local_shell_call_output`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the local shell tool call generated by the model." + }, + "output": { + "type": "string", + "description": "A JSON string of the output of the local shell tool call." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "nullable": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "The output of a local shell tool call.", + "title": "Local shell call output" + }, "OpenAI.OutputItemMcpApprovalRequest": { "type": "object", "required": [ @@ -30979,6 +32545,48 @@ "description": "A request for human approval of a tool invocation.", "title": "MCP approval request" }, + "OpenAI.OutputItemMcpApprovalResponseResource": { + "type": "object", + "required": [ + "type", + "id", + "approval_request_id", + "approve" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "mcp_approval_response" + ], + "description": "The type of the item. Always `mcp_approval_response`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique ID of the approval response" + }, + "approval_request_id": { + "type": "string", + "description": "The ID of the approval request being answered." + }, + "approve": { + "type": "boolean", + "description": "Whether the request was approved." + }, + "reason": { + "type": "string", + "nullable": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "A response to an MCP approval request.", + "title": "MCP approval response" + }, "OpenAI.OutputItemMcpListTools": { "type": "object", "required": [ @@ -31012,8 +32620,7 @@ "description": "The tools available on the server." }, "error": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" } }, "allOf": [ @@ -31124,6 +32731,14 @@ }, "description": "The content of the output message." }, + "phase": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.MessagePhase" + } + ], + "nullable": true + }, "status": { "type": "string", "enum": [ @@ -31142,61 +32757,181 @@ "description": "An output message from the model.", "title": "Output message" }, - "OpenAI.OutputItemReasoningItem": { + "OpenAI.OutputItemReasoningItem": { + "type": "object", + "required": [ + "type", + "id", + "summary" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "reasoning" + ], + "description": "The type of the object. Always `reasoning`.", + "x-stainless-const": true + }, + "id": { + "type": "string", + "description": "The unique identifier of the reasoning content." + }, + "encrypted_content": { + "type": "string", + "nullable": true + }, + "summary": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.SummaryTextContent" + }, + "description": "Reasoning summary content." + }, + "content": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.ReasoningTextContent" + }, + "description": "Reasoning text content." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "incomplete" + ], + "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ], + "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", + "title": "Reasoning" + }, + "OpenAI.OutputItemToolSearchCall": { + "type": "object", + "required": [ + "type", + "id", + "call_id", + "execution", + "arguments", + "status" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search_call" + ], + "description": "The type of the item. Always `tool_search_call`.", + "x-stainless-const": true, + "default": "tool_search_call" + }, + "id": { + "type": "string", + "description": "The unique ID of the tool search call item." + }, + "call_id": { + "type": "string", + "nullable": true + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." + }, + "arguments": { + "description": "Arguments used for the tool search call." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallStatus" + } + ], + "description": "The status of the tool search call item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.OutputItem" + } + ] + }, + "OpenAI.OutputItemToolSearchOutput": { "type": "object", "required": [ "type", "id", - "summary" + "call_id", + "execution", + "tools", + "status" ], "properties": { "type": { "type": "string", "enum": [ - "reasoning" + "tool_search_output" ], - "description": "The type of the object. Always `reasoning`.", - "x-stainless-const": true + "description": "The type of the item. Always `tool_search_output`.", + "x-stainless-const": true, + "default": "tool_search_output" }, "id": { "type": "string", - "description": "The unique identifier of the reasoning content." + "description": "The unique ID of the tool search output item." }, - "encrypted_content": { + "call_id": { "type": "string", "nullable": true }, - "summary": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAI.SummaryTextContent" - }, - "description": "Reasoning summary content." + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search was executed by the server or by the client." }, - "content": { + "tools": { "type": "array", "items": { - "$ref": "#/components/schemas/OpenAI.ReasoningTextContent" + "$ref": "#/components/schemas/OpenAI.Tool" }, - "description": "Reasoning text content." + "description": "The loaded tool definitions returned by tool search." }, "status": { - "type": "string", - "enum": [ - "in_progress", - "completed", - "incomplete" + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.FunctionCallOutputStatusEnum" + } ], - "description": "The status of the item. One of `in_progress`, `completed`, or\n `incomplete`. Populated when items are returned via API." + "description": "The status of the tool search output item that was recorded." + }, + "created_by": { + "type": "string", + "description": "The identifier of the actor that created the item." } }, "allOf": [ { "$ref": "#/components/schemas/OpenAI.OutputItem" } - ], - "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).", - "title": "Reasoning" + ] }, "OpenAI.OutputItemType": { "anyOf": [ @@ -31209,13 +32944,18 @@ "output_message", "file_search_call", "function_call", + "function_call_output", "web_search_call", "computer_call", + "computer_call_output", "reasoning", + "tool_search_call", + "tool_search_output", "compaction", "image_generation_call", "code_interpreter_call", "local_shell_call", + "local_shell_call_output", "shell_call", "shell_call_output", "apply_patch_call", @@ -31223,7 +32963,9 @@ "mcp_call", "mcp_list_tools", "mcp_approval_request", + "mcp_approval_response", "custom_tool_call", + "custom_tool_call_output", "structured_outputs", "oauth_consent_request", "memory_search_call", @@ -31435,6 +33177,13 @@ }, "description": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts)." }, + "OpenAI.PromptCacheRetentionEnum": { + "type": "string", + "enum": [ + "in_memory", + "24h" + ] + }, "OpenAI.RankerVersionType": { "type": "string", "enum": [ @@ -31471,6 +33220,123 @@ } } }, + "OpenAI.RealtimeMCPError": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/OpenAI.RealtimeMcpErrorType" + } + }, + "discriminator": { + "propertyName": "type", + "mapping": { + "protocol_error": "#/components/schemas/OpenAI.RealtimeMCPProtocolError", + "tool_execution_error": "#/components/schemas/OpenAI.RealtimeMCPToolExecutionError", + "http_error": "#/components/schemas/OpenAI.RealtimeMCPHTTPError" + } + } + }, + "OpenAI.RealtimeMCPHTTPError": { + "type": "object", + "required": [ + "type", + "code", + "message" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "http_error" + ], + "x-stainless-const": true + }, + "code": { + "$ref": "#/components/schemas/OpenAI.integer" + }, + "message": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + } + ], + "title": "Realtime MCP HTTP error" + }, + "OpenAI.RealtimeMCPProtocolError": { + "type": "object", + "required": [ + "type", + "code", + "message" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "protocol_error" + ], + "x-stainless-const": true + }, + "code": { + "$ref": "#/components/schemas/OpenAI.integer" + }, + "message": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + } + ], + "title": "Realtime MCP protocol error" + }, + "OpenAI.RealtimeMCPToolExecutionError": { + "type": "object", + "required": [ + "type", + "message" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_execution_error" + ], + "x-stainless-const": true + }, + "message": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.RealtimeMCPError" + } + ], + "title": "Realtime MCP tool execution error" + }, + "OpenAI.RealtimeMcpErrorType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "protocol_error", + "tool_execution_error", + "http_error" + ] + } + ] + }, "OpenAI.Reasoning": { "type": "object", "properties": { @@ -31595,7 +33461,8 @@ }, "safety_identifier": { "type": "string", - "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." + "maxLength": 64, + "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\n The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers)." }, "prompt_cache_key": { "type": "string", @@ -31607,7 +33474,7 @@ "prompt_cache_retention": { "type": "string", "enum": [ - "in-memory", + "in_memory", "24h" ], "nullable": true @@ -31633,15 +33500,6 @@ "type": "boolean", "nullable": true }, - "max_output_tokens": { - "type": "integer", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAI.integer" - } - ], - "nullable": true - }, "max_tool_calls": { "type": "integer", "allOf": [ @@ -31773,6 +33631,15 @@ ], "nullable": true }, + "max_output_tokens": { + "type": "integer", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.integer" + } + ], + "nullable": true + }, "agent": { "allOf": [ { @@ -31828,6 +33695,11 @@ "description": "A chunk of Base64 encoded response audio bytes." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial audio response.", "x-oaiMeta": { "name": "response.audio.delta", @@ -31859,6 +33731,11 @@ "description": "The sequence number of the delta." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the audio response is complete.", "x-oaiMeta": { "name": "response.audio.done", @@ -31895,6 +33772,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial transcript of audio.", "x-oaiMeta": { "name": "response.audio.transcript.delta", @@ -31926,6 +33808,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the full audio transcript is completed.", "x-oaiMeta": { "name": "response.audio.transcript.done", @@ -31976,6 +33863,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a partial code snippet is streamed by the code interpreter.", "x-oaiMeta": { "name": "response.code_interpreter_call_code.delta", @@ -32026,6 +33918,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the code snippet is finalized by the code interpreter.", "x-oaiMeta": { "name": "response.code_interpreter_call_code.done", @@ -32071,6 +33968,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the code interpreter call is completed.", "x-oaiMeta": { "name": "response.code_interpreter_call.completed", @@ -32116,6 +34018,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a code interpreter call is in progress.", "x-oaiMeta": { "name": "response.code_interpreter_call.in_progress", @@ -32161,6 +34068,11 @@ "description": "The sequence number of this event, used to order streaming events." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the code interpreter is actively interpreting the code snippet.", "x-oaiMeta": { "name": "response.code_interpreter_call.interpreting", @@ -32201,6 +34113,11 @@ "description": "The sequence number for this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the model response is complete.", "x-oaiMeta": { "name": "response.completed", @@ -32264,6 +34181,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a new content part is added.", "x-oaiMeta": { "name": "response.content_part.added", @@ -32327,6 +34249,11 @@ "description": "The content part that is done." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a content part is done.", "x-oaiMeta": { "name": "response.content_part.done", @@ -32367,6 +34294,11 @@ "description": "The sequence number for this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "An event that is emitted when a response is created.", "x-oaiMeta": { "name": "response.created", @@ -32417,6 +34349,11 @@ "description": "The incremental input data (delta) for the custom tool call." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Event representing a delta (partial update) to the input of a custom tool call.", "title": "ResponseCustomToolCallInputDelta", "x-oaiMeta": { @@ -32468,6 +34405,11 @@ "description": "The complete input data for the custom tool call." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Event indicating that input for a custom tool call is complete.", "title": "ResponseCustomToolCallInputDone", "x-oaiMeta": { @@ -32556,6 +34498,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an error occurs.", "x-oaiMeta": { "name": "error", @@ -32596,6 +34543,11 @@ "description": "The response that failed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "An event that is emitted when a response fails.", "x-oaiMeta": { "name": "response.failed", @@ -32641,6 +34593,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a file search call is completed (results found).", "x-oaiMeta": { "name": "response.file_search_call.completed", @@ -32686,6 +34643,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a file search call is initiated.", "x-oaiMeta": { "name": "response.file_search_call.in_progress", @@ -32731,6 +34693,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a file search is currently searching.", "x-oaiMeta": { "name": "response.file_search_call.searching", @@ -32877,6 +34844,11 @@ "description": "The function-call arguments delta that is added." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial function-call arguments delta.", "x-oaiMeta": { "name": "response.function_call_arguments.delta", @@ -32930,7 +34902,12 @@ "type": "string", "description": "The function-call arguments." } - }, + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when function-call arguments are finalized.", "x-oaiMeta": { "name": "response.function_call_arguments.done", @@ -32976,6 +34953,11 @@ "description": "The unique identifier of the image generation item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an image generation tool call has completed and the final image is available.", "title": "ResponseImageGenCallCompletedEvent", "x-oaiMeta": { @@ -33022,6 +35004,11 @@ "description": "The sequence number of the image generation item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an image generation tool call is actively generating an image (intermediate state).", "title": "ResponseImageGenCallGeneratingEvent", "x-oaiMeta": { @@ -33068,6 +35055,11 @@ "description": "The sequence number of the image generation item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an image generation tool call is in progress.", "title": "ResponseImageGenCallInProgressEvent", "x-oaiMeta": { @@ -33128,6 +35120,11 @@ "description": "Base64-encoded partial image data, suitable for rendering as an image." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a partial image is available during image generation streaming.", "title": "ResponseImageGenCallPartialImageEvent", "x-oaiMeta": { @@ -33169,6 +35166,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the response is in progress.", "x-oaiMeta": { "name": "response.in_progress", @@ -33221,6 +35223,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "An event that is emitted when a response finishes as incomplete.", "x-oaiMeta": { "name": "response.incomplete", @@ -33252,7 +35259,7 @@ "items": { "$ref": "#/components/schemas/OpenAI.ResponseLogProbTopLogprobs" }, - "description": "The log probability of the top 20 most likely tokens." + "description": "The log probabilities of up to 20 of the most likely tokens." } }, "description": "A logprob is the logarithmic probability that the model assigns to producing\na particular token at a given position in the sequence. Less-negative (higher)\nlogprob values indicate greater model confidence in that token choice." @@ -33311,6 +35318,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a delta (partial update) to the arguments of an MCP tool call.", "title": "ResponseMCPCallArgumentsDeltaEvent", "x-oaiMeta": { @@ -33362,6 +35374,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the arguments for an MCP tool call are finalized.", "title": "ResponseMCPCallArgumentsDoneEvent", "x-oaiMeta": { @@ -33408,6 +35425,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an MCP tool call has completed successfully.", "title": "ResponseMCPCallCompletedEvent", "x-oaiMeta": { @@ -33454,6 +35476,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an MCP tool call has failed.", "title": "ResponseMCPCallFailedEvent", "x-oaiMeta": { @@ -33500,6 +35527,11 @@ "description": "The unique identifier of the MCP tool call item being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an MCP tool call is in progress.", "title": "ResponseMCPCallInProgressEvent", "x-oaiMeta": { @@ -33546,6 +35578,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the list of available MCP tools has been successfully retrieved.", "title": "ResponseMCPListToolsCompletedEvent", "x-oaiMeta": { @@ -33592,6 +35629,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the attempt to list available MCP tools has failed.", "title": "ResponseMCPListToolsFailedEvent", "x-oaiMeta": { @@ -33638,6 +35680,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when the system is in the process of retrieving the list of available MCP tools.", "title": "ResponseMCPListToolsInProgressEvent", "x-oaiMeta": { @@ -33688,6 +35735,11 @@ "description": "The output item that was added." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a new output item is added.", "x-oaiMeta": { "name": "response.output_item.added", @@ -33737,6 +35789,11 @@ "description": "The output item that was marked done." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an output item is marked done.", "x-oaiMeta": { "name": "response.output_item.done", @@ -33809,6 +35866,11 @@ "description": "The annotation object being added. (See annotation schema for details.)" } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when an annotation is added to output text content.", "title": "ResponseOutputTextAnnotationAddedEvent", "x-oaiMeta": { @@ -33873,6 +35935,11 @@ "description": "The sequence number for this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a response is queued and waiting to be processed.", "title": "ResponseQueuedEvent", "x-oaiMeta": { @@ -33937,6 +36004,11 @@ "description": "The summary part that was added." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a new reasoning summary part is added.", "x-oaiMeta": { "name": "response.reasoning_summary_part.added", @@ -34019,6 +36091,11 @@ "description": "The completed summary part." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a reasoning summary part is completed.", "x-oaiMeta": { "name": "response.reasoning_summary_part.done", @@ -34097,6 +36174,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a delta is added to a reasoning summary text.", "x-oaiMeta": { "name": "response.reasoning_summary_text.delta", @@ -34156,6 +36238,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a reasoning summary text is completed.", "x-oaiMeta": { "name": "response.reasoning_summary_text.done", @@ -34215,6 +36302,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a delta is added to a reasoning text.", "x-oaiMeta": { "name": "response.reasoning_text.delta", @@ -34274,6 +36366,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a reasoning text is completed.", "x-oaiMeta": { "name": "response.reasoning_text.done", @@ -34333,6 +36430,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is a partial refusal text.", "x-oaiMeta": { "name": "response.refusal.delta", @@ -34392,6 +36494,11 @@ "description": "The sequence number of this event." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when refusal text is finalized.", "x-oaiMeta": { "name": "response.refusal.done", @@ -34399,6 +36506,140 @@ "example": "{\n \"type\": \"response.refusal.done\",\n \"item_id\": \"item-abc\",\n \"output_index\": 1,\n \"content_index\": 2,\n \"refusal\": \"final refusal text\",\n \"sequence_number\": 1\n}\n" } }, + "OpenAI.ResponseStreamEvent": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEventType" + } + }, + "discriminator": { + "propertyName": "type", + "mapping": { + "response.audio.transcript.delta": "#/components/schemas/OpenAI.ResponseAudioTranscriptDeltaEvent", + "response.code_interpreter_call_code.delta": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent", + "response.code_interpreter_call.in_progress": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallInProgressEvent", + "response.code_interpreter_call.interpreting": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallInterpretingEvent", + "response.content_part.added": "#/components/schemas/OpenAI.ResponseContentPartAddedEvent", + "response.created": "#/components/schemas/OpenAI.ResponseCreatedEvent", + "error": "#/components/schemas/OpenAI.ResponseErrorEvent", + "response.file_search_call.in_progress": "#/components/schemas/OpenAI.ResponseFileSearchCallInProgressEvent", + "response.file_search_call.searching": "#/components/schemas/OpenAI.ResponseFileSearchCallSearchingEvent", + "response.function_call_arguments.delta": "#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDeltaEvent", + "response.in_progress": "#/components/schemas/OpenAI.ResponseInProgressEvent", + "response.failed": "#/components/schemas/OpenAI.ResponseFailedEvent", + "response.incomplete": "#/components/schemas/OpenAI.ResponseIncompleteEvent", + "response.output_item.added": "#/components/schemas/OpenAI.ResponseOutputItemAddedEvent", + "response.reasoning_summary_part.added": "#/components/schemas/OpenAI.ResponseReasoningSummaryPartAddedEvent", + "response.reasoning_summary_text.delta": "#/components/schemas/OpenAI.ResponseReasoningSummaryTextDeltaEvent", + "response.reasoning_text.delta": "#/components/schemas/OpenAI.ResponseReasoningTextDeltaEvent", + "response.refusal.delta": "#/components/schemas/OpenAI.ResponseRefusalDeltaEvent", + "response.output_text.delta": "#/components/schemas/OpenAI.ResponseTextDeltaEvent", + "response.web_search_call.in_progress": "#/components/schemas/OpenAI.ResponseWebSearchCallInProgressEvent", + "response.web_search_call.searching": "#/components/schemas/OpenAI.ResponseWebSearchCallSearchingEvent", + "response.image_generation_call.generating": "#/components/schemas/OpenAI.ResponseImageGenCallGeneratingEvent", + "response.image_generation_call.in_progress": "#/components/schemas/OpenAI.ResponseImageGenCallInProgressEvent", + "response.image_generation_call.partial_image": "#/components/schemas/OpenAI.ResponseImageGenCallPartialImageEvent", + "response.mcp_call_arguments.delta": "#/components/schemas/OpenAI.ResponseMCPCallArgumentsDeltaEvent", + "response.mcp_call.failed": "#/components/schemas/OpenAI.ResponseMCPCallFailedEvent", + "response.mcp_call.in_progress": "#/components/schemas/OpenAI.ResponseMCPCallInProgressEvent", + "response.mcp_list_tools.failed": "#/components/schemas/OpenAI.ResponseMCPListToolsFailedEvent", + "response.mcp_list_tools.in_progress": "#/components/schemas/OpenAI.ResponseMCPListToolsInProgressEvent", + "response.output_text.annotation.added": "#/components/schemas/OpenAI.ResponseOutputTextAnnotationAddedEvent", + "response.queued": "#/components/schemas/OpenAI.ResponseQueuedEvent", + "response.custom_tool_call_input.delta": "#/components/schemas/OpenAI.ResponseCustomToolCallInputDeltaEvent", + "response.audio.done": "#/components/schemas/OpenAI.ResponseAudioDoneEvent", + "response.audio.transcript.done": "#/components/schemas/OpenAI.ResponseAudioTranscriptDoneEvent", + "response.code_interpreter_call_code.done": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCodeDoneEvent", + "response.code_interpreter_call.completed": "#/components/schemas/OpenAI.ResponseCodeInterpreterCallCompletedEvent", + "response.completed": "#/components/schemas/OpenAI.ResponseCompletedEvent", + "response.content_part.done": "#/components/schemas/OpenAI.ResponseContentPartDoneEvent", + "response.file_search_call.completed": "#/components/schemas/OpenAI.ResponseFileSearchCallCompletedEvent", + "response.function_call_arguments.done": "#/components/schemas/OpenAI.ResponseFunctionCallArgumentsDoneEvent", + "response.output_item.done": "#/components/schemas/OpenAI.ResponseOutputItemDoneEvent", + "response.reasoning_summary_part.done": "#/components/schemas/OpenAI.ResponseReasoningSummaryPartDoneEvent", + "response.reasoning_summary_text.done": "#/components/schemas/OpenAI.ResponseReasoningSummaryTextDoneEvent", + "response.reasoning_text.done": "#/components/schemas/OpenAI.ResponseReasoningTextDoneEvent", + "response.refusal.done": "#/components/schemas/OpenAI.ResponseRefusalDoneEvent", + "response.output_text.done": "#/components/schemas/OpenAI.ResponseTextDoneEvent", + "response.web_search_call.completed": "#/components/schemas/OpenAI.ResponseWebSearchCallCompletedEvent", + "response.image_generation_call.completed": "#/components/schemas/OpenAI.ResponseImageGenCallCompletedEvent", + "response.mcp_call_arguments.done": "#/components/schemas/OpenAI.ResponseMCPCallArgumentsDoneEvent", + "response.mcp_call.completed": "#/components/schemas/OpenAI.ResponseMCPCallCompletedEvent", + "response.mcp_list_tools.completed": "#/components/schemas/OpenAI.ResponseMCPListToolsCompletedEvent", + "response.custom_tool_call_input.done": "#/components/schemas/OpenAI.ResponseCustomToolCallInputDoneEvent", + "response.audio.delta": "#/components/schemas/OpenAI.ResponseAudioDeltaEvent" + } + } + }, + "OpenAI.ResponseStreamEventType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "enum": [ + "response.audio.delta", + "response.audio.done", + "response.audio.transcript.delta", + "response.audio.transcript.done", + "response.code_interpreter_call_code.delta", + "response.code_interpreter_call_code.done", + "response.code_interpreter_call.completed", + "response.code_interpreter_call.in_progress", + "response.code_interpreter_call.interpreting", + "response.completed", + "response.content_part.added", + "response.content_part.done", + "response.created", + "error", + "response.file_search_call.completed", + "response.file_search_call.in_progress", + "response.file_search_call.searching", + "response.function_call_arguments.delta", + "response.function_call_arguments.done", + "response.in_progress", + "response.failed", + "response.incomplete", + "response.output_item.added", + "response.output_item.done", + "response.reasoning_summary_part.added", + "response.reasoning_summary_part.done", + "response.reasoning_summary_text.delta", + "response.reasoning_summary_text.done", + "response.reasoning_text.delta", + "response.reasoning_text.done", + "response.refusal.delta", + "response.refusal.done", + "response.output_text.delta", + "response.output_text.done", + "response.web_search_call.completed", + "response.web_search_call.in_progress", + "response.web_search_call.searching", + "response.image_generation_call.completed", + "response.image_generation_call.generating", + "response.image_generation_call.in_progress", + "response.image_generation_call.partial_image", + "response.mcp_call_arguments.delta", + "response.mcp_call_arguments.done", + "response.mcp_call.completed", + "response.mcp_call.failed", + "response.mcp_call.in_progress", + "response.mcp_list_tools.completed", + "response.mcp_list_tools.failed", + "response.mcp_list_tools.in_progress", + "response.output_text.annotation.added", + "response.queued", + "response.custom_tool_call_input.delta", + "response.custom_tool_call_input.done" + ] + } + ] + }, "OpenAI.ResponseStreamOptions": { "type": "object", "properties": { @@ -34469,6 +36710,11 @@ "description": "The log probabilities of the tokens in the delta." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when there is an additional text delta.", "x-oaiMeta": { "name": "response.output_text.delta", @@ -34536,6 +36782,11 @@ "description": "The log probabilities of the tokens in the delta." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when text content is finalized.", "x-oaiMeta": { "name": "response.output_text.done", @@ -34668,6 +36919,11 @@ "description": "The sequence number of the web search call being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a web search call is completed.", "x-oaiMeta": { "name": "response.web_search_call.completed", @@ -34713,6 +36969,11 @@ "description": "The sequence number of the web search call being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a web search call is initiated.", "x-oaiMeta": { "name": "response.web_search_call.in_progress", @@ -34758,6 +37019,11 @@ "description": "The sequence number of the web search call being processed." } }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ResponseStreamEvent" + } + ], "description": "Emitted when a web search call is executing.", "x-oaiMeta": { "name": "response.web_search_call.searching", @@ -34839,6 +37105,13 @@ } ], "description": "The vertical scroll distance." + }, + "keys": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } }, "allOf": [ @@ -34849,6 +37122,13 @@ "description": "A scroll action.", "title": "Scroll" }, + "OpenAI.SearchContentType": { + "type": "string", + "enum": [ + "text", + "image" + ] + }, "OpenAI.SearchContextSize": { "type": "string", "enum": [ @@ -34869,6 +37149,15 @@ "description": "Specifies the processing type used for serving the request.\n- If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n- If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n- If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier.\n- When not set, the default behavior is 'auto'.\nWhen the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.", "nullable": true }, + "OpenAI.ServiceTierEnum": { + "type": "string", + "enum": [ + "auto", + "default", + "flex", + "priority" + ] + }, "OpenAI.SkillReferenceParam": { "type": "object", "required": [ @@ -35163,7 +37452,10 @@ "shell": "#/components/schemas/OpenAI.FunctionShellToolParam", "custom": "#/components/schemas/OpenAI.CustomToolParam", "web_search_preview": "#/components/schemas/OpenAI.WebSearchPreviewTool", - "apply_patch": "#/components/schemas/OpenAI.ApplyPatchToolParam" + "apply_patch": "#/components/schemas/OpenAI.ApplyPatchToolParam", + "computer": "#/components/schemas/OpenAI.ComputerTool", + "namespace": "#/components/schemas/OpenAI.NamespaceToolParam", + "tool_search": "#/components/schemas/OpenAI.ToolSearchToolParam" } }, "description": "A tool that can be used to generate a response." @@ -35229,6 +37521,46 @@ ], "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." }, + "OpenAI.ToolChoiceComputer": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer" + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" + } + ], + "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." + }, + "OpenAI.ToolChoiceComputerUse": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "computer_use" + ] + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolChoiceParam" + } + ], + "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." + }, "OpenAI.ToolChoiceComputerUsePreview": { "type": "object", "required": [ @@ -35411,7 +37743,9 @@ "computer_use_preview": "#/components/schemas/OpenAI.ToolChoiceComputerUsePreview", "web_search_preview_2025_03_11": "#/components/schemas/OpenAI.ToolChoiceWebSearchPreview20250311", "image_generation": "#/components/schemas/OpenAI.ToolChoiceImageGeneration", - "code_interpreter": "#/components/schemas/OpenAI.ToolChoiceCodeInterpreter" + "code_interpreter": "#/components/schemas/OpenAI.ToolChoiceCodeInterpreter", + "computer": "#/components/schemas/OpenAI.ToolChoiceComputer", + "computer_use": "#/components/schemas/OpenAI.ToolChoiceComputerUse" } }, "description": "How the model should select which tool (or tools) to use when generating\na response. See the `tools` parameter to see how to specify which tools\nthe model can call." @@ -35435,7 +37769,9 @@ "computer_use_preview", "web_search_preview_2025_03_11", "image_generation", - "code_interpreter" + "code_interpreter", + "computer", + "computer_use" ] } ] @@ -35480,6 +37816,58 @@ ], "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)." }, + "OpenAI.ToolSearchExecutionType": { + "type": "string", + "enum": [ + "server", + "client" + ] + }, + "OpenAI.ToolSearchToolParam": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tool_search" + ], + "description": "The type of the tool. Always `tool_search`.", + "x-stainless-const": true, + "default": "tool_search" + }, + "execution": { + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.ToolSearchExecutionType" + } + ], + "description": "Whether tool search is executed by the server or by the client." + }, + "description": { + "type": "string", + "nullable": true + }, + "parameters": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.EmptyModelParam" + } + ], + "nullable": true + } + }, + "allOf": [ + { + "$ref": "#/components/schemas/OpenAI.Tool" + } + ], + "description": "Hosted or BYOT tool search configuration for deferred tools.", + "title": "Tool search tool" + }, "OpenAI.ToolType": { "anyOf": [ { @@ -35490,6 +37878,7 @@ "enum": [ "function", "file_search", + "computer", "computer_use_preview", "web_search", "mcp", @@ -35498,6 +37887,8 @@ "local_shell", "shell", "custom", + "namespace", + "tool_search", "web_search_preview", "apply_patch", "a2a_preview", @@ -35807,7 +38198,8 @@ "x-stainless-const": true }, "url": { - "type": "string" + "type": "string", + "format": "uri" } } }, @@ -35877,6 +38269,12 @@ } ], "description": "High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default." + }, + "search_content_types": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OpenAI.SearchContentType" + } } }, "allOf": [